Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio Verify Webhooks API

3 actions 3 updates phrasing extends openapi/twilio-webhooks-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Twilio's API. It is a proposal applied on top of the contract, not a document Twilio publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/Services/{ServiceSid}/Webhooks'].get
$.paths['/Services/{ServiceSid}/Webhooks'].post

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 Verify Webhooks API
  version: 1.0.0
extends: openapi/twilio-webhooks-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/Services/{ServiceSid}/Webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List a Verify service's webhooks
      effect: read
      questions:
      - Which webhooks are registered on my Verify service?
      - Where do I see the URLs my verification events are sent to?
      instructions:
      - text: List the webhooks on Verify service {service}.
        slots:
          service: path.ServiceSid
      - text: Show every event callback configured for service {service}.
        slots:
          service: path.ServiceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Services/{ServiceSid}/Webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a webhook to a Verify service
      effect: write
      questions:
      - How do I get notified at my own URL when verification events happen?
      - Can I create a webhook that starts out disabled?
      instructions:
      - text: Create webhook {name} on Verify service {service} sending {event_types} to {url}.
        slots:
          name: requestBody.FriendlyName
          service: path.ServiceSid
          event_types: requestBody.EventTypes
          url: requestBody.WebhookUrl
      - text: Add a {status} webhook {name} to service {service} for {event_types} at {url}.
        slots:
          status: requestBody.Status
          name: requestBody.FriendlyName
          service: path.ServiceSid
          event_types: requestBody.EventTypes
          url: requestBody.WebhookUrl
      method: generated
      generated: '2026-09-26'