# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Methodfi Webhooks API
  version: 1.0.0
extends: openapi/methodfi-webhooks-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhooks
      effect: read
      questions:
      - Which webhooks are active or need attention on my team?
      - Can I see every webhook I've registered?
      instructions:
      - text: List my webhooks on API version {version}.
        slots:
          version: header.Method-Version
      - text: Show all active and requires-attention webhooks.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a URL to an event type
      effect: write
      questions:
      - How do I get notified at my URL when a given event happens?
      - Can I sign webhook deliveries with an HMAC secret?
      instructions:
      - text: Create a webhook for {type} events sent to {url}.
        slots:
          type: requestBody.type
          url: requestBody.url
      - text: Send {type} events to {url} signed with HMAC secret {hmac_secret}.
        slots:
          type: requestBody.type
          url: requestBody.url
          hmac_secret: requestBody.hmac_secret
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhooks/{webhookId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook (versioned)
      effect: read
      questions:
      - Which versioned call returns one webhook by webhookId?
      - Can I check a webhook's configuration on the current API version?
      instructions:
      - text: Get webhook {webhook} on API version {version}.
        slots:
          webhook: path.webhookId
          version: header.Method-Version
      - text: Show the configuration of webhook {webhook}.
        slots:
          webhook: path.webhookId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhooks/{webhookId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook (versioned)
      effect: destructive
      questions:
      - How do I stop receiving events at a webhook on the current API version?
      - Can I remove a webhook subscription by its webhookId?
      instructions:
      - text: Delete webhook {webhook} on API version {version}.
        slots:
          webhook: path.webhookId
          version: header.Method-Version
      - text: Unsubscribe webhook {webhook} using idempotency key {key}.
        slots:
          webhook: path.webhookId
          key: header.Idempotency-Key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhooks/{webhookId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a webhook's status
      effect: write
      questions:
      - How do I re-enable a webhook that was disabled?
      - Can I pause a webhook by changing its status?
      instructions:
      - text: Set webhook {webhook} status to {status}.
        slots:
          webhook: path.webhookId
          status: requestBody.status
      - text: Change the status of webhook {webhook} to {status}.
        slots:
          webhook: path.webhookId
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhooks/{whk_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook (legacy unversioned path)
      effect: read
      questions:
      - Is there an older webhook lookup that takes whk_id without a version header?
      - Can I still read a webhook via the legacy whk_id endpoint?
      instructions:
      - text: Look up webhook {whk_id} on the legacy unversioned endpoint.
        slots:
          whk_id: path.whk_id
      - text: Fetch webhook {whk_id} without sending a Method-Version header.
        slots:
          whk_id: path.whk_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhooks/{whk_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook (legacy path)
      effect: destructive
      questions:
      - Can I delete a webhook through the older whk_id endpoint?
      - Does the legacy webhook delete work without a version header?
      instructions:
      - text: Delete webhook {whk_id} on the legacy unversioned path.
        slots:
          whk_id: path.whk_id
      - text: Remove legacy webhook {whk_id} without a Method-Version header.
        slots:
          whk_id: path.whk_id
      method: generated
      generated: '2026-10-01'