# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Things Stack — Integrations Application Webhook Registry API
  version: 1.0.0
extends: openapi/the-things-network-applicationwebhookregistry-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['/as/webhook-formats'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported webhook payload formats
      effect: read
      questions:
      - Which payload formats can webhooks send, like JSON or protobuf?
      - What message encodings does the Application Server support for webhooks?
      instructions:
      - text: List the supported webhook formats.
      - text: Show which payload encodings webhooks can use.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/as/webhook-templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhook integration templates
      effect: read
      questions:
      - What ready-made webhook templates are available for integrations?
      - Can I browse the catalog of webhook templates before setting one up?
      instructions:
      - text: List all webhook templates.
      - text: List webhook templates showing only {field_mask}.
        slots:
          field_mask: query.field_mask
      method: generated
      generated: '2026-09-26'
- target: $.paths['/as/webhook-templates/{ids.template_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook template
      effect: read
      questions:
      - What fields and endpoints does a specific webhook template need?
      - Can I view one integration template's details by its ID?
      instructions:
      - text: Show webhook template {template_id}.
        slots:
          template_id: path.ids.template_id
      - text: Get the setup details of template {template_id}.
        slots:
          template_id: path.ids.template_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/as/webhooks/{application_ids.application_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List an application's webhooks
      effect: read
      questions:
      - Which webhooks are configured on my Things Stack application?
      - Can I page through all webhooks set up for an app?
      instructions:
      - text: List the webhooks of application {application_id}.
        slots:
          application_id: path.application_ids.application_id
      - text: Show {limit} webhooks per page for app {application_id}.
        slots:
          limit: query.limit
          application_id: path.application_ids.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/as/webhooks/{application_ids.application_id}/{webhook_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - How do I remove a webhook from my application?
      - Does deleting a webhook stop uplinks from being posted to it immediately?
      instructions:
      - text: Delete webhook {webhook_id} from application {application_id}.
        slots:
          webhook_id: path.webhook_id
          application_id: path.application_ids.application_id
      - text: Remove the {webhook_id} integration from app {application_id}.
        slots:
          webhook_id: path.webhook_id
          application_id: path.application_ids.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/as/webhooks/{ids.application_ids.application_id}/{ids.webhook_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook's configuration
      effect: read
      questions:
      - What URL and message types is a given webhook configured with?
      - Can I read one webhook's settings by its ID?
      instructions:
      - text: Show webhook {webhook_id} of application {application_id}.
        slots:
          webhook_id: path.ids.webhook_id
          application_id: path.ids.application_ids.application_id
      - text: Get the {field_mask} of webhook {webhook_id} in app {application_id}.
        slots:
          field_mask: query.field_mask
          webhook_id: path.ids.webhook_id
          application_id: path.ids.application_ids.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/as/webhooks/{webhook.ids.application_ids.application_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook for an application
      effect: write
      questions:
      - How do I add a new webhook to forward my application's uplinks to my server?
      - Can I create a webhook without picking its ID in the URL?
      instructions:
      - text: Create webhook {webhook} on application {application_id}.
        slots:
          webhook: requestBody.webhook
          application_id: path.webhook.ids.application_ids.application_id
      - text: Add a new webhook integration to app {application_id}.
        slots:
          application_id: path.webhook.ids.application_ids.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/as/webhooks/{webhook.ids.application_ids.application_id}/{webhook.ids.webhook_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a named webhook
      effect: write
      questions:
      - How do I change the endpoint of an existing webhook?
      - Can I update only some fields of a webhook using a field mask?
      instructions:
      - text: Update webhook {webhook_id} on application {application_id} to {webhook}.
        slots:
          webhook_id: path.webhook.ids.webhook_id
          application_id: path.webhook.ids.application_ids.application_id
          webhook: requestBody.webhook
      - text: Set fields {field_mask} on webhook {webhook_id} in app {application_id}.
        slots:
          field_mask: requestBody.field_mask
          webhook_id: path.webhook.ids.webhook_id
          application_id: path.webhook.ids.application_ids.application_id
      method: generated
      generated: '2026-09-26'