Webhooks

Webhooks let a repository call an external URL whenever chosen events happen in it, so you can notify a chat channel, trigger an external build, or feed your own automation. On the repository's Webhooks settings page you add a webhook, choose which events it receives, secure its payloads with a secret, turn it on or off, and inspect or re-send its most recent delivery. Only a repository owner or administrator can manage webhooks.

Where to find it

Webhooks: gitvetrix.com/{owner}/{repo}/settings/webhooks
Navigation: Open a repository, select Settings, then select Webhooks in the left settings sidebar.

If you do not administer the repository, the page shows a message stating that you do not have permission to manage its webhooks.

Read the webhook list

The page lists every webhook configured for the repository. Each row shows:

An Active or Inactive badge for whether the webhook is currently delivering.
The payload URL the webhook posts to.
A badge for each subscribed event. When a webhook subscribes to more than three events, the first three appear and the rest are summarized as a +N badge.
The most recent delivery, when one exists. If that delivery captured a response, its status is shown as a Show delivery payload control; otherwise the status appears as plain text.
Redeliver, Edit, and Delete buttons.

When the repository has no webhooks yet, the page shows No webhooks configured with a prompt to add one so you receive notifications when repository events occur.

Add a webhook

Select Add webhook.
In Payload URL, enter the full URL that should receive the event, such as https://example.com/webhook. This field is required and must be a valid URL.
In Secret, optionally enter a shared secret. Vetrix uses it to sign each payload so your endpoint can verify the request came from Vetrix. The secret is write-only: it is never shown again after you save.
Under Events, select the events that trigger a delivery (see Choose events).
Leave Active selected to start delivering right away, or clear it to add the webhook without delivering yet.
Select Save webhook.

A confirmation appears and the new webhook is added to the list.

Choose events

Under Events, select any combination of the following. A new webhook starts with push selected.

push — commits are pushed to the repository.
pull_request — a merge request is opened, updated, or closed.
issues — an issue is opened, edited, closed, or reopened.
issue_comment — a comment is added to an issue.
release — a release is published.
pipeline — a pipeline run changes state.
deployment — a deployment is created or its status changes.

Edit a webhook

On the webhook's row, select Edit.
Change the Payload URL, Events, or Active state as needed.
To rotate the shared secret, enter a new value in Secret. Leave Secret blank to keep the existing one. Because the secret is write-only, the field is always empty when you open the form.
Select Save webhook.

Turn a webhook on or off

Use the Active checkbox in the add or edit form to control delivery. When a webhook is inactive, its row shows an Inactive badge and no events are delivered to its URL until you turn it back on.

Inspect and re-send a delivery

View the last delivery. When the most recent delivery captured a response, select Show delivery payload on the webhook's row to expand the recorded delivery, including its status and the raw JSON payload. Select Hide delivery payload to collapse it again.
Re-send the last delivery. Select Redeliver on the webhook's row to send the most recent event to the payload URL again. This is useful when your endpoint was down or you are testing your handler. A confirmation appears once the re-delivery is triggered.

Delete a webhook

On the webhook's row, select Delete.
In the Delete webhook dialog, read the warning. Deleting a webhook is permanent and stops all future events from being delivered to its URL.
Select the confirm button to remove the webhook.