SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Integrations External Integration Endpoints…

6 actions 6 updates phrasing extends openapi/sendgrid-external-integration-endpoints-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/marketing/integrations'].get
$.paths['/v3/marketing/integrations'].post
$.paths['/v3/marketing/integrations'].delete
$.paths['/v3/marketing/integrations/{id}'].get
$.paths['/v3/marketing/integrations/{id}'].patch

OpenAPI Overlay

Raw ↑
# 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 Integrations External Integration Endpoints…
  version: 1.0.0
extends: openapi/sendgrid-external-integration-endpoints-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/marketing/integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List email event forwarding integrations
      effect: read
      questions:
      - Which integrations am I using to forward email events?
      - What event forwarding destinations have I set up?
      instructions:
      - text: List my email event integrations.
      - text: Show all my event forwarding integrations.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/integrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an email event forwarding integration
      effect: write
      questions:
      - Can I forward my email events to an outside destination like Segment?
      - How many integrations of one destination type am I allowed?
      instructions:
      - text: Create an integration to {destination} with filters {filters} and properties {properties}.
        slots:
          destination: requestBody.destination
          filters: requestBody.filters
          properties: requestBody.properties
      - text: Forward email events to {destination} labeled {label}, filters {filters}, properties {properties}.
        slots:
          destination: requestBody.destination
          label: requestBody.label
          filters: requestBody.filters
          properties: requestBody.properties
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/integrations'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete event forwarding integrations
      effect: destructive
      questions:
      - Can I delete several event integrations at once?
      - What's the way to stop forwarding email events to a destination?
      instructions:
      - text: Delete integrations {ids}.
        slots:
          ids: query.ids
      - text: Remove event forwarding integrations {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/integrations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one event forwarding integration
      effect: read
      questions:
      - What filters and settings does a specific integration have?
      - Can I look up an event integration by its ID?
      instructions:
      - text: Show integration {id}.
        slots:
          id: path.id
      - text: Get the configuration of event integration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/marketing/integrations/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an event forwarding integration
      effect: write
      questions:
      - Can I change which events an existing integration forwards?
      - Is it possible to relabel one of my integrations?
      instructions:
      - text: Update integration {id} to use filters {filters}.
        slots:
          id: path.id
          filters: requestBody.filters
      - text: Rename integration {id} to {label}.
        slots:
          id: path.id
          label: requestBody.label
      method: generated
      generated: '2026-09-24'