# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for GitLab Webhooks Webhook Configuration API
  version: 1.0.0
extends: openapi/gitlab-webhook-configuration-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: 4
- target: $.paths['/projects/{id}/hooks/{hook_id}/custom_headers/{key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a custom header on a webhook
      effect: write
      questions:
      - How do I add an authorization header to every delivery from a project webhook?
      - Can I send a custom HTTP header with GitLab webhook requests?
      instructions:
      - text: Set header {key} to {value} on webhook {hook_id} of project {id}.
        slots:
          key: path.key
          value: requestBody.value
          hook_id: path.hook_id
          id: path.id
      - text: 'Add custom header {key}: {value} to hook {hook_id} in {id}.'
        slots:
          key: path.key
          value: requestBody.value
          hook_id: path.hook_id
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{id}/hooks/{hook_id}/custom_headers/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a custom header from a webhook
      effect: destructive
      questions:
      - How do I stop a webhook from sending one of its custom headers?
      - Can I delete a single custom header without recreating the hook?
      instructions:
      - text: Remove custom header {key} from webhook {hook_id} in project {id}.
        slots:
          key: path.key
          hook_id: path.hook_id
          id: path.id
      - text: Delete the {key} header on hook {hook_id} of {id}.
        slots:
          key: path.key
          hook_id: path.hook_id
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{id}/hooks/{hook_id}/url_variables/{key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a URL variable on a webhook
      effect: write
      questions:
      - How do I keep a secret out of a webhook URL by using a URL variable?
      - Can I substitute a placeholder in the webhook URL with a stored value?
      instructions:
      - text: Set URL variable {key} to {value} on webhook {hook_id} of project {id}.
        slots:
          key: path.key
          value: requestBody.value
          hook_id: path.hook_id
          id: path.id
      - text: Store {value} as the {key} URL placeholder for hook {hook_id} in {id}.
        slots:
          value: requestBody.value
          key: path.key
          hook_id: path.hook_id
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{id}/hooks/{hook_id}/url_variables/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a URL variable from a webhook
      effect: destructive
      questions:
      - How do I delete a URL variable I no longer substitute into a webhook URL?
      - What happens to the webhook URL once I remove one of its URL variables?
      instructions:
      - text: Remove URL variable {key} from webhook {hook_id} in project {id}.
        slots:
          key: path.key
          hook_id: path.hook_id
          id: path.id
      - text: Delete the {key} URL placeholder value on hook {hook_id} of {id}.
        slots:
          key: path.key
          hook_id: path.hook_id
          id: path.id
      method: generated
      generated: '2026-09-26'