# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Bitly Webhooks API
  version: 1.0.0
extends: openapi/bitly-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: 6
- target: $.paths['/organizations/{organization_guid}/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's webhooks
      effect: read
      questions:
      - Which webhooks are set up for my Bitly organization?
      - Can I see every webhook endpoint configured across an organization?
      instructions:
      - text: List all webhooks for organization {organization_guid}.
        slots:
          organization_guid: path.organization_guid
      - text: Show me the webhooks configured in organization {organization_guid}.
        slots:
          organization_guid: path.organization_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook
      effect: write
      questions:
      - How do I get notified at my own URL when an event happens in Bitly?
      - Can a new webhook be limited to a single group instead of the whole organization?
      - Is it possible to protect a webhook endpoint with OAuth client credentials?
      instructions:
      - text: Create a webhook named {name} in organization {organization_guid} that sends {event} events to {url}.
        slots:
          name: requestBody.name
          organization_guid: requestBody.organization_guid
          event: requestBody.event
          url: requestBody.url
      - text: Set up a new webhook {name} for group {group_guid} in organization {organization_guid} posting {event} to {url}.
        slots:
          name: requestBody.name
          group_guid: requestBody.group_guid
          organization_guid: requestBody.organization_guid
          event: requestBody.event
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/{webhook_guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook's configuration
      effect: read
      questions:
      - What URL and event is a specific webhook configured with?
      - Is a particular webhook currently active?
      instructions:
      - text: Show webhook {webhook_guid}.
        slots:
          webhook_guid: path.webhook_guid
      - text: Fetch the configuration of webhook {webhook_guid}.
        slots:
          webhook_guid: path.webhook_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/{webhook_guid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - How do I remove a webhook I no longer need?
      - Can I permanently stop a webhook rather than just pausing it?
      instructions:
      - text: Delete webhook {webhook_guid}.
        slots:
          webhook_guid: path.webhook_guid
      - text: Remove the webhook {webhook_guid} permanently.
        slots:
          webhook_guid: path.webhook_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/{webhook_guid}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update or pause a webhook
      effect: write
      questions:
      - Can I change the destination URL of an existing webhook?
      - How do I deactivate a webhook without deleting it?
      instructions:
      - text: Point existing webhook {webhook_guid} at {url}.
        slots:
          webhook_guid: path.webhook_guid
          url: requestBody.url
      - text: Set is_active to {is_active} on webhook {webhook_guid}.
        slots:
          is_active: requestBody.is_active
          webhook_guid: path.webhook_guid
      - text: Rename webhook {webhook_guid} to {name}.
        slots:
          webhook_guid: path.webhook_guid
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/{webhook_guid}/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test ping to a webhook
      effect: write
      questions:
      - How can I test that my webhook endpoint is receiving events?
      - Can I send a ping event to check a webhook's configuration?
      instructions:
      - text: Send a test ping to webhook {webhook_guid}.
        slots:
          webhook_guid: path.webhook_guid
      - text: Verify webhook {webhook_guid} is configured correctly.
        slots:
          webhook_guid: path.webhook_guid
      method: generated
      generated: '2026-09-26'