# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Trello Webhooks API
  version: 1.0.0
extends: openapi/trello-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['/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook on a Trello model
      effect: write
      questions:
      - How do I get notified at my URL whenever a board changes?
      - Why does my callback URL need to answer a HEAD request with 200 before the webhook is created?
      instructions:
      - text: Create a webhook on model {idModel} that posts to {callbackURL}.
        slots:
          idModel: query.idModel
          callbackURL: query.callbackURL
      - text: Set up a webhook for {idModel} calling {callbackURL} with description {description}.
        slots:
          idModel: query.idModel
          callbackURL: query.callbackURL
          description: query.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook's configuration
      effect: read
      questions:
      - How do I check which URL and model a webhook is pointed at?
      - Can I see whether a webhook is still active?
      instructions:
      - text: Get webhook {id}.
        slots:
          id: path.id
      - text: Show the full configuration of webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a webhook's URL, model or active state
      effect: write
      questions:
      - Can I point an existing webhook at a new callback URL?
      - How do I pause a webhook without deleting it?
      instructions:
      - text: Change the callback URL of webhook {id} to {callbackURL}.
        slots:
          id: path.id
          callbackURL: query.callbackURL
      - text: Set webhook {id} active to {active}.
        slots:
          id: path.id
          active: query.active
      - text: Point webhook {id} at model {idModel} instead.
        slots:
          id: path.id
          idModel: query.idModel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - How do I stop Trello from sending events to my endpoint for good?
      - Is deleting a webhook permanent?
      instructions:
      - text: Delete webhook {id}.
        slots:
          id: path.id
      - text: Permanently remove webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook via the trailing-slash endpoint
      effect: write
      questions:
      - Does POST /webhooks/ with the trailing slash create a webhook the same way?
      - Can I register a webhook against the /webhooks/ path variant?
      instructions:
      - text: Using the /webhooks/ trailing-slash path, create a webhook on {idModel} posting to {callbackURL}.
        slots:
          idModel: query.idModel
          callbackURL: query.callbackURL
      - text: Register an inactive webhook via /webhooks/ for {idModel} to {callbackURL} with active {active}.
        slots:
          idModel: query.idModel
          callbackURL: query.callbackURL
          active: query.active
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/{id}/{field}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read one field of a webhook
      effect: read
      questions:
      - Can I read just the callback URL field of a webhook?
      - What's the lightest way to check a single webhook property?
      instructions:
      - text: Get the {field} field of webhook {id}.
        slots:
          field: path.field
          id: path.id
      - text: Read only {field} from webhook {id}.
        slots:
          field: path.field
          id: path.id
      method: generated
      generated: '2026-09-26'