# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Nylas Webhook Notifications API
  version: 1.0.0
extends: openapi/nylas-webhook-notifications-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: 8
- target: $.paths['/v3/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List all webhook destinations
      effect: read
      questions:
      - Which webhook URLs is my Nylas application sending notifications to?
      - Can I see every webhook destination configured for my app?
      instructions:
      - text: List all webhook destinations for my application.
      - text: Show every webhook endpoint my app delivers to.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook destination
      effect: write
      questions:
      - How do I start receiving webhooks when new messages or events arrive?
      - Can I get an email alert if my webhook endpoint goes down?
      - Is it possible to receive gzip-compressed webhook payloads?
      instructions:
      - text: Create a webhook to {webhook_url} for triggers {trigger_types}.
        slots:
          webhook_url: requestBody.webhook_url
          trigger_types: requestBody.trigger_types
      - text: Register webhook {webhook_url} for {trigger_types} and alert {notification_email_addresses} if it fails.
        slots:
          webhook_url: requestBody.webhook_url
          trigger_types: requestBody.trigger_types
          notification_email_addresses: requestBody.notification_email_addresses
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/webhooks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one webhook destination
      effect: read
      questions:
      - What triggers and URL are set on a particular webhook destination?
      - Can I check the status of a single webhook by its ID?
      instructions:
      - text: Show webhook destination {id}.
        slots:
          id: path.id
      - text: Get the configuration of webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/webhooks/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a webhook destination
      effect: write
      questions:
      - Can I change which triggers an existing webhook listens for?
      - How do I reactivate a webhook destination that was paused?
      instructions:
      - text: Change the URL of webhook {id} to {webhook_url}.
        slots:
          id: path.id
          webhook_url: requestBody.webhook_url
      - text: Set webhook {id} to listen for {trigger_types}.
        slots:
          id: path.id
          trigger_types: requestBody.trigger_types
      - text: Set the status of webhook {id} to {status}.
        slots:
          id: path.id
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/webhooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook destination
      effect: destructive
      questions:
      - How do I stop Nylas from sending notifications to an old webhook URL?
      - Can I remove a webhook destination I no longer use?
      instructions:
      - text: Delete webhook destination {id}.
        slots:
          id: path.id
      - text: Remove webhook {id} so it stops receiving notifications.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/webhooks/rotate-secret/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate a webhook's signing secret
      effect: destructive
      questions:
      - How can I rotate the secret used to sign webhook notifications?
      - Does the old webhook secret stop working right after rotation?
      instructions:
      - text: Rotate the signing secret for webhook {id}.
        slots:
          id: path.id
      - text: Generate a new webhook secret for destination {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/webhooks/mock-payload'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview a sample webhook payload
      effect: read
      questions:
      - What does a webhook notification body look like for a given trigger?
      - Can I see an example webhook payload before building my handler?
      instructions:
      - text: Show me a sample webhook payload for trigger {trigger_type}.
        slots:
          trigger_type: requestBody.trigger_type
      - text: Preview the webhook notification body for {trigger_type}.
        slots:
          trigger_type: requestBody.trigger_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/webhooks/send-test-event'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test event to a webhook URL
      effect: write
      questions:
      - How do I check that my webhook endpoint is set up correctly?
      - Which secret signs the test webhook Nylas sends?
      instructions:
      - text: Send a test {trigger_type} webhook to {webhook_url}.
        slots:
          trigger_type: requestBody.trigger_type
          webhook_url: requestBody.webhook_url
      - text: Fire a test event at {webhook_url} for trigger {trigger_type} and confirm it acknowledges.
        slots:
          webhook_url: requestBody.webhook_url
          trigger_type: requestBody.trigger_type
      method: generated
      generated: '2026-09-26'