Skip to content

Trigger a test webhook

POST
/api/v4/projects/{id}/hooks/{hook_id}/test/{trigger}

Triggers a test webhook. This endpoint has a rate limit of five requests per minute for each authenticated user for a given project or group. On GitLab Self-Managed and GitLab Dedicated, an administrator can change this limit in the application settings.

hook_id
required
integer

The ID of the hook

trigger
required
string
>= 1 characters
Allowed values: confidential_issues_events confidential_note_events deployment_events emoji_events feature_flag_events issues_events job_events merge_requests_events milestone_events note_events pipeline_events push_events releases_events resource_access_token_events resource_deploy_token_events tag_push_events wiki_page_events vulnerability_events

The type of trigger hook

id
required
One of:
string

The ID or URL-encoded path of the project

Example
1

Created

Bad request

Forbidden

Not found

Unprocessable entity

Too many requests