# 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 Webhook Configuration Event Webhook API
  version: 1.0.0
extends: openapi/sendgrid-event-webhook-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: 8
- target: $.paths['/v3/user/webhooks/event/settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an Event Webhook
      effect: write
      questions:
      - Can I get delivery, open and bounce events posted to my own URL?
      - Is it possible to secure an Event Webhook with OAuth credentials?
      instructions:
      - text: Create an Event Webhook posting to {url}.
        slots:
          url: requestBody.url
      - text: 'Create an Event Webhook named {friendly_name} at {url} that sends bounce events: {bounce}.'
        slots:
          friendly_name: requestBody.friendly_name
          url: requestBody.url
          bounce: requestBody.bounce
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/webhooks/event/settings/all'].get
  update:
    x-apievangelist-phrasing:
      intent: List all Event Webhooks
      effect: read
      questions:
      - What Event Webhooks do I have configured and where do they post?
      - Which events is each of my webhooks set to deliver?
      instructions:
      - text: List all my Event Webhooks.
      - text: Show my Event Webhooks including {include}.
        slots:
          include: query.include
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/webhooks/event/settings/signed/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Event Webhook's signing public key
      effect: read
      questions:
      - Where do I find the public key to verify signed Event Webhook requests?
      - Can I get the verification key for a specific webhook?
      instructions:
      - text: Get the signature public key for Event Webhook {id}.
        slots:
          id: path.id
      - text: Show the signing key for webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/webhooks/event/settings/signed/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Toggle signature verification on an Event Webhook
      effect: write
      questions:
      - Can I turn on signed requests for one of my Event Webhooks?
      - Is it possible to disable signature verification on a webhook?
      instructions:
      - text: Set signature verification for Event Webhook {id} to {enabled}.
        slots:
          id: path.id
          enabled: requestBody.enabled
      - text: 'Turn on signing for webhook {id}: {enabled}.'
        slots:
          id: path.id
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/webhooks/event/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test event to a webhook URL
      effect: write
      questions:
      - Can I check that my endpoint receives Event Webhook posts before real data flows?
      - Is there a way to test my webhook's OAuth configuration with a fake event?
      instructions:
      - text: Send a test event notification to {url}.
        slots:
          url: requestBody.url
      - text: Test Event Webhook {id} by posting a fake event to {url}.
        slots:
          id: requestBody.id
          url: requestBody.url
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/webhooks/event/settings/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Event Webhook's settings
      effect: read
      questions:
      - What URL and events is a particular Event Webhook configured with?
      - Which webhook do I get back if I don't pass an ID?
      instructions:
      - text: Show the settings for Event Webhook {id}.
        slots:
          id: path.id
      - text: Get Event Webhook {id} including {include}.
        slots:
          id: path.id
          include: query.include
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/webhooks/event/settings/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Event Webhook
      effect: destructive
      questions:
      - Can I remove an Event Webhook I no longer need?
      - Does deleting a webhook require its ID?
      instructions:
      - text: Delete Event Webhook {id}.
        slots:
          id: path.id
      - text: Remove webhook {id} so it stops posting events.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/webhooks/event/settings/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an Event Webhook's URL or events
      effect: write
      questions:
      - Can I change which events an existing webhook sends or where it posts?
      - Is it possible to add OAuth to a webhook I already created?
      instructions:
      - text: Point Event Webhook {id} at {url}.
        slots:
          id: path.id
          url: requestBody.url
      - text: 'Update webhook {id} at {url} to stop sending open events: {open}.'
        slots:
          id: path.id
          url: requestBody.url
          open: requestBody.open
      - text: Set Event Webhook {id} at {url} enabled to {enabled}.
        slots:
          id: path.id
          url: requestBody.url
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-24'