SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Alerts API

6 actions 6 updates phrasing extends openapi/sendgrid-alerts-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for SendGrid's API. It is a proposal applied on top of the contract, not a document SendGrid publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/v3/alerts'].get

$.paths['/v3/alerts'].post

$.paths['/v3/alerts/{alert_id}'].get

$.paths['/v3/alerts/{alert_id}'].delete

$.paths['/v3/alerts/{alert_id}'].patch

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Twilio SendGrid Alerts API
  version: 1.0.0
extends: openapi/sendgrid-alerts-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v3/alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: List usage and stats alerts
      effect: read
      questions:
      - Which email alerts do I have set up on my account?
      - Where can I see all my usage-limit and stats notification alerts?
      instructions:
      - text: List all of my alerts.
      - text: Show every alert configured on the account.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a usage or stats alert
      effect: write
      questions:
      - Can I get emailed when I've used a certain percentage of my monthly sending limit?
      - How do I receive a daily or weekly stats summary by email?
      instructions:
      - text: Create a {type} alert sent to {email_to} at {percentage} percent.
        slots:
          type: requestBody.type
          email_to: requestBody.email_to
          percentage: requestBody.percentage
      - text: Email {email_to} a {type} alert every {frequency}.
        slots:
          email_to: requestBody.email_to
          type: requestBody.type
          frequency: requestBody.frequency
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/alerts/{alert_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one alert
      effect: read
      questions:
      - Who receives a particular alert and how often?
      - What threshold is a specific alert set to?
      instructions:
      - text: Show alert {alert_id}.
        slots:
          alert_id: path.alert_id
      - text: Get the recipient and frequency of alert {alert_id}.
        slots:
          alert_id: path.alert_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/alerts/{alert_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an alert
      effect: destructive
      questions:
      - How do I stop getting a specific alert email?
      - Can I remove an alert by its ID?
      instructions:
      - text: Delete alert {alert_id}.
        slots:
          alert_id: path.alert_id
      - text: Turn off and remove alert {alert_id}.
        slots:
          alert_id: path.alert_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/alerts/{alert_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an existing alert
      effect: write
      questions:
      - Can I send an existing alert to a different email address?
      - Is it possible to change the percentage threshold on an alert I already have?
      instructions:
      - text: Send alert {alert_id} to {email_to} instead.
        slots:
          alert_id: path.alert_id
          email_to: requestBody.email_to
      - text: Change alert {alert_id} to fire at {percentage} percent.
        slots:
          alert_id: path.alert_id
          percentage: requestBody.percentage
      - text: Set existing alert {alert_id} frequency to {frequency}.
        slots:
          alert_id: path.alert_id
          frequency: requestBody.frequency
      method: generated
      generated: '2026-09-24'