# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Sentry Projects Service Hooks API
  version: 1.0.0
extends: openapi/sentry-system-service-hooks-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: 5
- target: $.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/hooks/'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's service hooks
      effect: read
      questions:
      - Which webhooks are registered as service hooks on my project?
      - Can I page through a project's service hooks?
      instructions:
      - text: List service hooks for project {project} in {org}.
        slots:
          project: path.project_id_or_slug
          org: path.organization_id_or_slug
      - text: Show more of project {project}'s service hooks from cursor {cursor}.
        slots:
          project: path.project_id_or_slug
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/hooks/'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a service hook
      effect: write
      questions:
      - How do I send project events to my own webhook URL?
      - Which events can a service hook subscribe to?
      instructions:
      - text: Register a service hook on project {project} in {org} posting {events} to {url}.
        slots:
          project: path.project_id_or_slug
          org: path.organization_id_or_slug
          events: requestBody.events
          url: requestBody.url
      - text: Create a webhook at {url} for {events} events.
        slots:
          url: requestBody.url
          events: requestBody.events
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/hooks/{hook_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a service hook
      effect: read
      questions:
      - What URL and events does a service hook have?
      - Can I view one service hook by ID?
      instructions:
      - text: Show service hook {hook_id} in project {project} of {org}.
        slots:
          hook_id: path.hook_id
          project: path.project_id_or_slug
          org: path.organization_id_or_slug
      - text: Fetch service hook {hook_id}.
        slots:
          hook_id: path.hook_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/hooks/{hook_id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a service hook
      effect: write
      questions:
      - How do I change where a service hook sends events?
      - Can I change the event types a hook listens for?
      instructions:
      - text: Point service hook {hook_id} on project {project} in {org} at {url}.
        slots:
          hook_id: path.hook_id
          project: path.project_id_or_slug
          org: path.organization_id_or_slug
          url: requestBody.url
      - text: Set service hook {hook_id} events to {events}.
        slots:
          hook_id: path.hook_id
          events: requestBody.events
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/hooks/{hook_id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a service hook
      effect: destructive
      questions:
      - How do I stop a service hook from sending events?
      - Can I delete a webhook from a project?
      instructions:
      - text: Remove service hook {hook_id} from project {project} in {org}.
        slots:
          hook_id: path.hook_id
          project: path.project_id_or_slug
          org: path.organization_id_or_slug
      - text: Delete service hook {hook_id}.
        slots:
          hook_id: path.hook_id
      method: generated
      generated: '2026-09-26'