Skip to content

Register a webhook

Mate receives GitLab events through a webhook. This step is manual: the console gives you the URL and secret; you paste them into GitLab. It is the Add the webhook in GitLab item on the workspace Home checklist, and the same panel is under Settings → GitLab connection.

Click Show webhook. The panel displays:

  • URL: https://ingest.mate.engineer/hook/<your-workspace-id>. Use the copy button next to it.
  • Secret token: shown in full only right after it is created or rotated, until you mark the setup as done or leave the tab. Afterwards you see only a masked preview (and only as Manager or Owner). If you did not copy the secret in time, click Rotate secret and confirm; the previous secret stays valid for 24 hours so you can update GitLab without downtime.
  • Events to enable: the list of GitLab event types below.
  • Last delivery: time, event and status (accepted, ignored or rejected) of the last delivery that reached Mate with a valid secret, or never. ignored means the event was not one Mate acts on.
  1. In GitLab, open the project (or group) you want Mate to work in.

  2. Go to Settings → Webhooks.

  3. Click Add new webhook.

  4. Paste the URL from the console into the URL field.

  5. Paste the Secret token into the Secret token field.

  6. Under Trigger, enable the following event types:

    Event type Covers
    Work item events (older GitLab: Issues events) on: issue triggers
    Merge request events on: merge_request triggers
    Comments on: note triggers (@mentions)
    Pipeline events on: pipeline triggers (for example failed pipelines)

    If you use triggers for other kinds (push, tag_push, job, deployment, release, wiki_page), enable the matching GitLab event types as well. Leave the rest unchecked.

    If you want Mate to react to confidential issues or confidential comments, also enable the corresponding “Confidential” variants.

  7. Click Add webhook.

Mate waits for the first delivery. Once GitLab delivers an event, the item shows Delivery received. If you want to finish the checklist item before any event arrives, click I’ve done this; the item then shows Marked as done. You can send a test event from GitLab (Settings → Webhooks → Test) to see Last delivery fill in.

Next: Run your first job