# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for JFrog Platform REST Webhooks API
  version: 1.0.0
extends: openapi/jfrog-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: 5
- target: $.paths['/event/api/v1/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhooks
      effect: read
      questions:
      - What webhooks are configured on my platform?
      - Can I see all event subscriptions and their URLs?
      instructions:
      - text: List all webhooks.
      - text: Show every webhook subscription.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event/api/v1/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook subscription
      effect: write
      questions:
      - How do I get notified at my URL when an artifact is deployed?
      - Can I sign webhook payloads with a secret?
      instructions:
      - text: Create webhook {key} sending {events} to {url}.
        slots:
          key: requestBody.key
          events: requestBody.events
          url: requestBody.url
      - text: Subscribe {url} to events {events} as webhook {key} with secret {secret}.
        slots:
          url: requestBody.url
          events: requestBody.events
          key: requestBody.key
          secret: requestBody.secret
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event/api/v1/subscriptions/{webhookKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook
      effect: read
      questions:
      - How do I see which events a specific webhook listens for?
      - What URL does one webhook post to?
      instructions:
      - text: Show webhook {webhookKey}.
        slots:
          webhookKey: path.webhookKey
      - text: Get the configuration of webhook {webhookKey}.
        slots:
          webhookKey: path.webhookKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event/api/v1/subscriptions/{webhookKey}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a webhook
      effect: write
      questions:
      - How do I change the target URL of an existing webhook?
      - Can I disable a webhook without deleting it?
      instructions:
      - text: Point webhook {webhookKey} at {url} for events {events}, key {key}.
        slots:
          webhookKey: path.webhookKey
          url: requestBody.url
          events: requestBody.events
          key: requestBody.key
      - text: Set webhook {webhookKey} enabled to {enabled}.
        slots:
          webhookKey: path.webhookKey
          enabled: requestBody.enabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event/api/v1/subscriptions/{webhookKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - How do I stop a webhook from firing permanently?
      - Can I delete a webhook subscription by key?
      instructions:
      - text: Delete webhook {webhookKey}.
        slots:
          webhookKey: path.webhookKey
      - text: Remove the {webhookKey} webhook subscription.
        slots:
          webhookKey: path.webhookKey
      method: generated
      generated: '2026-10-01'