API Evangelist conversational phrasing for Svix Endpoint API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Svix Endpoint API
  version: 1.0.0
extends: openapi/svix-endpoint-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: 35
- target: $.paths['/api/v1/app/{app_id}/endpoint'].get
  update:
    x-apievangelist-phrasing:
      intent: List an application's webhook endpoints
      effect: read
      questions:
      - Which webhook endpoints are registered for one of my Svix applications?
      - Can I page through an application's endpoints newest first?
      - What endpoint URLs does a given customer app currently deliver to?
      instructions:
      - text: List all webhook endpoints for application {app_id}.
        slots:
          app_id: path.app_id
      - text: Show the first {limit} endpoints of app {app_id} in {order} order.
        slots:
          limit: query.limit
          app_id: path.app_id
          order: query.order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a webhook endpoint to an application
      effect: write
      questions:
      - How do I register a new webhook URL for one of my applications?
      - Can a new endpoint only receive certain event types or channels?
      - Will the signing secret be generated for me if I leave it out when adding an endpoint?
      instructions:
      - text: Add a new webhook endpoint at {url} to application {app_id}.
        slots:
          url: requestBody.url
          app_id: path.app_id
      - text: Create an endpoint {url} on app {app_id} that only receives the {filterTypes} event types.
        slots:
          url: requestBody.url
          app_id: path.app_id
          filterTypes: requestBody.filterTypes
      - text: Register a new endpoint {url} for app {app_id} throttled to {throttleRate} messages per second.
        slots:
          url: requestBody.url
          app_id: path.app_id
          throttleRate: requestBody.throttleRate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook endpoint's details
      effect: read
      questions:
      - What URL, filters and settings does a specific webhook endpoint have?
      - Is a particular endpoint currently disabled?
      instructions:
      - text: Show me endpoint {endpoint_id} in application {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: Fetch the configuration of webhook endpoint {endpoint_id} for app {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a webhook endpoint
      effect: write
      questions:
      - Can I upsert an endpoint by its ID so it's created if it doesn't exist yet?
      - How do I replace an endpoint's whole configuration, including its URL?
      instructions:
      - text: Upsert endpoint {endpoint_id} in app {app_id} with URL {url}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          url: requestBody.url
      - text: 'Replace the full settings of endpoint {endpoint_id} on app {app_id}: URL {url}, description {description}.'
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          url: requestBody.url
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook endpoint
      effect: destructive
      questions:
      - How do I remove a webhook endpoint a customer no longer uses?
      - Can I permanently delete an endpoint from an application?
      instructions:
      - text: Delete endpoint {endpoint_id} from application {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: Remove the webhook endpoint {endpoint_id} of app {app_id} for good.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change some settings of a webhook endpoint
      effect: write
      questions:
      - Can I disable an endpoint without resending its whole configuration?
      - How do I change just the event type filter on an existing endpoint?
      instructions:
      - text: Disable endpoint {endpoint_id} in app {app_id} by setting disabled to {disabled}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          disabled: requestBody.disabled
      - text: Partially update endpoint {endpoint_id} on app {app_id} so it only gets channels {channels}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          channels: requestBody.channels
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/connector'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the connector linked to an endpoint
      effect: read
      questions:
      - Which connector is an endpoint built from?
      - Can I see the connector behind a specific webhook endpoint?
      instructions:
      - text: Show the connector associated with endpoint {endpoint_id} in app {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: Look up which connector endpoint {endpoint_id} of application {app_id} uses.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/sink'].get
  update:
    x-apievangelist-phrasing:
      intent: List an application's sinks
      effect: read
      questions:
      - What sinks are set up for an application alongside its endpoints?
      - Can I page through an app's sinks with a limit?
      instructions:
      - text: List the sinks configured on application {app_id}.
        slots:
          app_id: path.app_id
      - text: Show up to {limit} sinks for app {app_id}.
        slots:
          limit: query.limit
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/sink'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a sink for an application
      effect: write
      questions:
      - How do I add a sink to an application instead of an HTTP endpoint?
      - Can a sink be limited to certain channels when I create it?
      instructions:
      - text: Create a new sink on application {app_id}.
        slots:
          app_id: path.app_id
      - text: Add a sink to app {app_id} described as {description} that listens only to channels {channels}.
        slots:
          app_id: path.app_id
          description: requestBody.description
          channels: requestBody.channels
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/sink/{sink_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sink on an application
      effect: read
      questions:
      - What is the configuration of a specific sink on my app?
      - Can I check whether a given application sink is disabled?
      instructions:
      - text: Show sink {sink_id} of application {app_id}.
        slots:
          sink_id: path.sink_id
          app_id: path.app_id
      - text: Fetch the details of app {app_id}'s sink {sink_id}.
        slots:
          sink_id: path.sink_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/cancel-msgs'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel pending messages to an endpoint
      effect: destructive
      questions:
      - How do I stop pending webhooks created before a certain time from being delivered?
      - Is cancelling queued messages to an endpoint immediate?
      instructions:
      - text: Cancel all pending messages to endpoint {endpoint_id} in app {app_id} created before {createdBefore}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          createdBefore: requestBody.createdBefore
      - text: Drop the backlog of unsent webhooks for endpoint {endpoint_id} on app {app_id} older than {createdBefore}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          createdBefore: requestBody.createdBefore
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/secret'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an endpoint's signing secret
      effect: read
      questions:
      - Where do I find the secret to verify webhook signatures for an endpoint?
      - What signing secret is my receiver supposed to check payloads against?
      instructions:
      - text: Get the signing secret for endpoint {endpoint_id} in application {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: Show me the webhook verification secret of endpoint {endpoint_id} on app {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/secret/rotate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate an endpoint's signing secret
      effect: write
      questions:
      - How do I rotate a webhook endpoint's signing secret without breaking verification?
      - How long does the old endpoint secret stay valid after rotation?
      instructions:
      - text: Rotate the signing secret of endpoint {endpoint_id} in app {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: Rotate endpoint {endpoint_id}'s secret on app {app_id} and keep the old one valid for {gracePeriodSeconds} seconds.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          gracePeriodSeconds: requestBody.gracePeriodSeconds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/headers'].get
  update:
    x-apievangelist-phrasing:
      intent: Get custom headers sent to an endpoint
      effect: read
      questions:
      - Which extra HTTP headers are added to webhooks sent to an endpoint?
      - Can I see the custom headers configured on a webhook endpoint?
      instructions:
      - text: Show the additional headers sent with webhooks to endpoint {endpoint_id} in app {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: List the custom headers on endpoint {endpoint_id} of application {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/headers'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace the custom headers on an endpoint
      effect: write
      questions:
      - How do I set the full list of extra headers sent with an endpoint's webhooks?
      - Can I overwrite every custom header on an endpoint in one call?
      instructions:
      - text: Set the headers of endpoint {endpoint_id} in app {app_id} to exactly {headers}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          headers: requestBody.headers
      - text: Replace all custom webhook headers on endpoint {endpoint_id} of application {app_id} with {headers}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          headers: requestBody.headers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/headers'].patch
  update:
    x-apievangelist-phrasing:
      intent: Add or remove some custom headers on an endpoint
      effect: write
      questions:
      - Can I add one header to an endpoint without wiping the others?
      - How do I delete a single custom header from a webhook endpoint?
      instructions:
      - text: Add headers {headers} to endpoint {endpoint_id} in app {app_id}, keeping the existing ones.
        slots:
          headers: requestBody.headers
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: On endpoint {endpoint_id} of app {app_id}, merge in headers {headers} and remove {deleteHeaders}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          headers: requestBody.headers
          deleteHeaders: requestBody.deleteHeaders
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/transformation'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an endpoint's transformation code
      effect: read
      questions:
      - What transformation code runs on payloads before they reach an endpoint?
      - Is a payload transformation enabled on a given webhook endpoint?
      instructions:
      - text: Show the transformation code for endpoint {endpoint_id} in app {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: Fetch the payload transformation attached to endpoint {endpoint_id} of application {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/transformation'].patch
  update:
    x-apievangelist-phrasing:
      intent: Set or remove an endpoint's transformation
      effect: write
      questions:
      - How do I attach JavaScript transformation code to a webhook endpoint?
      - Can I turn off an endpoint's transformation without deleting the code?
      instructions:
      - text: Set the transformation code of endpoint {endpoint_id} in app {app_id} to {code}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          code: requestBody.code
      - text: Set the transformation on endpoint {endpoint_id} of app {app_id} to enabled={enabled}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/transformation/simulate'].post
  update:
    x-apievangelist-phrasing:
      intent: Test an endpoint transformation on a sample payload
      effect: read
      questions:
      - Can I dry-run transformation code against a sample payload for one of my endpoints?
      - What would a webhook look like after my endpoint's transformation runs?
      instructions:
      - text: Simulate transformation {code} on endpoint {endpoint_id} of app {app_id} for a {eventType} event with payload {payload}.
        slots:
          code: requestBody.code
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          eventType: requestBody.eventType
          payload: requestBody.payload
      - text: Preview what endpoint {endpoint_id} in app {app_id} would receive if code {code} transformed {payload} as event {eventType}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          code: requestBody.code
          payload: requestBody.payload
          eventType: requestBody.eventType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/replay-missing'].post
  update:
    x-apievangelist-phrasing:
      intent: Replay messages an endpoint never received
      effect: write
      questions:
      - How do I send an endpoint the webhooks it missed while it was offline?
      - Will replaying missing messages resend ones the endpoint already got?
      instructions:
      - text: Replay all messages endpoint {endpoint_id} in app {app_id} never received since {since}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          since: requestBody.since
      - text: Send endpoint {endpoint_id} of app {app_id} the webhooks it missed between {since} and {until}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          since: requestBody.since
          until: requestBody.until
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/bulk-replay'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk replay successful and failed messages
      effect: write
      questions:
      - Can I replay every message sent to an endpoint in a time window, including successful ones?
      - Is it possible to bulk replay only one event type or tag to an endpoint?
      - Can a bulk replay be limited to messages that got a 5xx response?
      instructions:
      - text: Bulk replay every message sent to endpoint {endpoint_id} in app {app_id} since {since}, successes included.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          since: requestBody.since
      - text: Bulk replay {eventTypes} messages to endpoint {endpoint_id} of app {app_id} created since {since}.
        slots:
          eventTypes: requestBody.eventTypes
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          since: requestBody.since
      - text: Bulk replay messages tagged {tag} to endpoint {endpoint_id} on app {app_id} from {since} to {until}.
        slots:
          tag: requestBody.tag
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          since: requestBody.since
          until: requestBody.until
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/oauth'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an endpoint's OAuth configuration
      effect: read
      questions:
      - What OAuth client and token URL does an endpoint use to authenticate deliveries?
      - Does fetching an endpoint's OAuth settings return a 404 when OAuth isn't set up?
      instructions:
      - text: Get the OAuth configuration of endpoint {endpoint_id} in app {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: Show the OAuth grant type and token URL set on endpoint {endpoint_id} of application {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/oauth'].put
  update:
    x-apievangelist-phrasing:
      intent: Configure OAuth for webhook deliveries
      effect: write
      questions:
      - How do I make webhook deliveries to an endpoint fetch an OAuth access token first?
      - Which OAuth grant types and client auth methods can an endpoint use?
      instructions:
      - text: Set OAuth on endpoint {endpoint_id} in app {app_id} using client {clientId}, token URL {tokenUrl}, grant {grantType} and auth method {authMethod}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          clientId: requestBody.clientId
          tokenUrl: requestBody.tokenUrl
          grantType: requestBody.grantType
          authMethod: requestBody.authMethod
      - text: Configure endpoint {endpoint_id} of app {app_id} for OAuth grant {grantType} via {authMethod} with client {clientId} at {tokenUrl}, scopes {scopes}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          grantType: requestBody.grantType
          authMethod: requestBody.authMethod
          clientId: requestBody.clientId
          tokenUrl: requestBody.tokenUrl
          scopes: requestBody.scopes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/oauth'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove OAuth from an endpoint
      effect: destructive
      questions:
      - How do I stop an endpoint from using OAuth for its webhook deliveries?
      - Can I delete the OAuth client settings stored on an endpoint?
      instructions:
      - text: Delete the OAuth configuration from endpoint {endpoint_id} in app {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: Turn off OAuth-authenticated delivery for endpoint {endpoint_id} of application {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/oauth-config'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether OAuth is enabled on an endpoint
      effect: read
      questions:
      - Is OAuth enabled on an endpoint, without getting an error if it isn't?
      - How can I read an endpoint's OAuth status as enabled true or false?
      instructions:
      - text: Check whether OAuth is enabled on endpoint {endpoint_id} in app {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: Get the OAuth status and config for endpoint {endpoint_id} of app {app_id}, returning enabled false if unset.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/ca'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an endpoint's custom CA certificate
      effect: read
      questions:
      - Which custom CA certificate is trusted when delivering to a given endpoint?
      - Does my endpoint have a custom server CA set?
      instructions:
      - text: Show the custom CA certificate for endpoint {endpoint_id} in app {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: Fetch the server CA cert used to verify endpoint {endpoint_id} of application {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/ca'].put
  update:
    x-apievangelist-phrasing:
      intent: Set or clear an endpoint's custom CA certificate
      effect: write
      questions:
      - How do I deliver webhooks to an endpoint that uses a self-signed or private CA?
      - Can I clear a custom CA certificate from an endpoint?
      instructions:
      - text: Trust CA certificate {cert} for deliveries to endpoint {endpoint_id} in app {app_id}.
        slots:
          cert: requestBody.cert
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: Unset the custom CA certificate on endpoint {endpoint_id} of application {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/mtls'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an endpoint's mTLS configuration
      effect: read
      questions:
      - What client certificate is presented when delivering to an endpoint over mTLS?
      - Does reading an endpoint's mTLS settings fail with a 404 if mTLS isn't configured?
      instructions:
      - text: Get the mTLS configuration of endpoint {endpoint_id} in app {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: Show the mutual TLS client identity set on endpoint {endpoint_id} of application {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/mtls'].put
  update:
    x-apievangelist-phrasing:
      intent: Configure mutual TLS for an endpoint
      effect: write
      questions:
      - How do I make webhook deliveries present a client certificate for mTLS?
      - Can I give an endpoint its own mTLS identity?
      instructions:
      - text: Set mTLS on endpoint {endpoint_id} in app {app_id} with client identity {identity}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          identity: requestBody.identity
      - text: Enable mutual TLS for deliveries to endpoint {endpoint_id} of app {app_id} using identity {identity}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          identity: requestBody.identity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/mtls'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove mutual TLS from an endpoint
      effect: destructive
      questions:
      - How do I stop presenting a client certificate to an endpoint?
      - Can I delete the mTLS identity configured on an endpoint?
      instructions:
      - text: Delete the mTLS configuration from endpoint {endpoint_id} in app {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: Turn off mutual TLS for endpoint {endpoint_id} of application {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/mtls-config'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether mTLS is enabled on an endpoint
      effect: read
      questions:
      - Is mutual TLS turned on for an endpoint, without an error when it's off?
      - Rather than a 404, can I get back a simple on/off flag for an endpoint's client-certificate setup?
      instructions:
      - text: Check whether mTLS is enabled on endpoint {endpoint_id} in app {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: Report whether endpoint {endpoint_id} of app {app_id} has a client certificate configured, with its mTLS config if so.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get delivery statistics for an endpoint
      effect: read
      questions:
      - How many webhooks to an endpoint succeeded, failed or are still pending?
      - Can I see an endpoint's delivery stats for a specific date range?
      instructions:
      - text: Show delivery statistics for endpoint {endpoint_id} in app {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: Get endpoint {endpoint_id}'s stats on app {app_id} from {since} to {until}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          since: query.since
          until: query.until
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/rate-limit-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if an endpoint's rate limit is throttling it
      effect: read
      questions:
      - Is an endpoint's rate limit slowing down delivery to it right now?
      - Why are webhooks to one endpoint arriving late — is it being throttled?
      instructions:
      - text: Check the throttling status of endpoint {endpoint_id} in app {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: Tell me if the rate limit is impacting delivery to endpoint {endpoint_id} of application {app_id}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/recover'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend failed webhooks to an endpoint
      effect: write
      questions:
      - How do I retry all the webhooks that failed for an endpoint after fixing it?
      - Will recovering failed messages resend ones that eventually succeeded?
      instructions:
      - text: Recover all failed messages to endpoint {endpoint_id} in app {app_id} since {since}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          since: requestBody.since
      - text: Resend only the failed webhooks for endpoint {endpoint_id} of app {app_id} between {since} and {until}.
        slots:
          endpoint_id: path.endpoint_id
          app_id: path.app_id
          since: requestBody.since
          until: requestBody.until
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/endpoint/{endpoint_id}/send-example'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an example event to an endpoint
      effect: write
      questions:
      - Can I send a test webhook of a specific event type to an endpoint?
      - How do I check a receiver works using an event type's example payload?
      instructions:
      - text: Send an example {eventType} message to endpoint {endpoint_id} in app {app_id}.
        slots:
          eventType: requestBody.eventType
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      - text: Fire example number {exampleIndex} of event type {eventType} at endpoint {endpoint_id} on app {app_id}.
        slots:
          exampleIndex: requestBody.exampleIndex
          eventType: requestBody.eventType
          endpoint_id: path.endpoint_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'