# 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 Webhook Security API
  version: 1.0.0
extends: openapi/sendgrid-webhook-security-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/user/webhooks/security/policies'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhook security policies
      effect: read
      questions:
      - Which webhook security policies are configured on my account?
      - Can I see whether each webhook policy uses signing or OAuth?
      instructions:
      - text: List all my webhook security policies.
      - text: Show every webhook security policy with its configuration.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/webhooks/security/policies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook security policy
      effect: write
      questions:
      - How do I make webhooks sign their requests so I can verify them?
      - Can a webhook security policy use OAuth instead of a signature?
      instructions:
      - text: Create webhook security policy {name} with signature settings {signature}.
        slots:
          name: requestBody.name
          signature: requestBody.signature
      - text: Create a webhook policy {name} that authenticates with OAuth {oauth}.
        slots:
          name: requestBody.name
          oauth: requestBody.oauth
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/webhooks/security/policies/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one webhook security policy
      effect: read
      questions:
      - What settings does a specific webhook security policy have?
      - Can I look up a webhook policy by its ID?
      instructions:
      - text: Show webhook security policy {id}.
        slots:
          id: path.id
      - text: Get the signature and OAuth details of policy {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/webhooks/security/policies/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook security policy
      effect: destructive
      questions:
      - Can I delete a webhook security policy that's still in use?
      - Is deleting a webhook policy permanent?
      instructions:
      - text: Delete webhook security policy {id}.
        slots:
          id: path.id
      - text: Force-delete webhook policy {id} with force set to {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/webhooks/security/policies/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a webhook security policy
      effect: write
      questions:
      - Can I rotate or change the signing settings on an existing webhook policy?
      - Is renaming a webhook security policy supported?
      instructions:
      - text: Rename webhook security policy {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Change the OAuth settings on webhook policy {id} to {oauth}.
        slots:
          id: path.id
          oauth: requestBody.oauth
      method: generated
      generated: '2026-09-24'