# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Netlify's API documentation Hook API
  version: 1.0.0
extends: openapi/netlify-hook-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['/hooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List a site's notification hooks
      effect: read
      questions:
      - What notifications are set up for my site's deploys?
      - Can I see all outgoing webhooks and email hooks on a site?
      instructions:
      - text: List notification hooks for site {site}.
        slots:
          site: query.site_id
      - text: Show every deploy notification configured on site {site}.
        slots:
          site: query.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a deploy notification hook
      effect: write
      questions:
      - How do I get a webhook when a deploy succeeds or fails?
      - Can I add an email notification for a site event?
      instructions:
      - text: Add a {type} notification on site {site} for the {event} event.
        slots:
          type: requestBody.type
          site: query.site_id
          event: requestBody.event
      - text: Create a webhook hook for site {site} that fires on {event}.
        slots:
          site: query.site_id
          event: requestBody.event
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hooks/{hook_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a notification hook
      effect: read
      questions:
      - Can I see how a notification hook is configured?
      - Which event triggers a particular hook?
      instructions:
      - text: Get notification hook {hook}.
        slots:
          hook: path.hook_id
      - text: Show the event and settings of hook {hook}.
        slots:
          hook: path.hook_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hooks/{hook_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a notification hook
      effect: write
      questions:
      - Can I change which event a notification hook listens to?
      - How do I disable a notification without deleting it?
      instructions:
      - text: Update hook {hook} to trigger on {event}.
        slots:
          hook: path.hook_id
          event: requestBody.event
      - text: Change the settings of notification hook {hook}.
        slots:
          hook: path.hook_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hooks/{hook_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a notification hook
      effect: destructive
      questions:
      - How do I remove a deploy notification?
      - Can I delete a webhook I set up for my site?
      instructions:
      - text: Delete notification hook {hook}.
        slots:
          hook: path.hook_id
      - text: Remove hook {hook} from its site.
        slots:
          hook: path.hook_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hooks/{hook_id}/enable'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-enable a disabled notification hook
      effect: write
      questions:
      - Can I turn a disabled notification hook back on?
      - What do I do when a webhook was automatically disabled?
      instructions:
      - text: Enable notification hook {hook}.
        slots:
          hook: path.hook_id
      - text: Turn hook {hook} back on.
        slots:
          hook: path.hook_id
      method: generated
      generated: '2026-09-26'