Generated by API Evangelist
Written by API Evangelist tooling for GitLab's API. It is a proposal applied on top of the contract, not a document GitLab publishes.
# 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 Events API
version: 1.0.0
extends: openapi/gitlab-webhook-events-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: 3
- target: $.paths['/projects/{id}/hooks/{hook_id}/events'].get
update:
x-apievangelist-phrasing:
intent: List recent deliveries of a project webhook
effect: read
questions:
- How do I see what a webhook sent and what my server answered over the last week?
- Which recent webhook deliveries failed with an error status code?
instructions:
- text: List recent delivery events for webhook {hook_id} on project {id}.
slots:
hook_id: path.hook_id
id: path.id
- text: Show the last 7 days of deliveries from hook {hook_id} in {id}.
slots:
hook_id: path.hook_id
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/projects/{id}/hooks/{hook_id}/events/{hook_event_id}/resend'].post
update:
x-apievangelist-phrasing:
intent: Resend a past webhook delivery
effect: write
questions:
- How do I retry a webhook delivery that failed?
- Can I replay one specific event to my endpoint again?
instructions:
- text: Resend event {hook_event_id} from webhook {hook_id} on project {id}.
slots:
hook_event_id: path.hook_event_id
hook_id: path.hook_id
id: path.id
- text: Retry the failed delivery {hook_event_id} of hook {hook_id} in {id}.
slots:
hook_event_id: path.hook_event_id
hook_id: path.hook_id
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/projects/{id}/hooks/{hook_id}/test/{trigger}'].post
update:
x-apievangelist-phrasing:
intent: Send a test payload to a webhook
effect: write
questions:
- How do I check my webhook endpoint is reachable before real events arrive?
- Can I simulate a push or merge request event against a hook?
instructions:
- text: Send a test {trigger} payload to webhook {hook_id} on project {id}.
slots:
trigger: path.trigger
hook_id: path.hook_id
id: path.id
- text: Fire a simulated {trigger} event at hook {hook_id} in {id}.
slots:
trigger: path.trigger
hook_id: path.hook_id
id: path.id
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.