Webhooks

Webhooks are how you can plug in your minions (our word for applications, LLMs or any other automated process) to help build or use your repo.

Setting up a Webhook

You can create a new webhook for your repo, by clicking the "+ Create Webhook" button in the upper left hand corner of the webhooks page of your repo.

  • Name - This is the name of your webhook, so that you and other's in your org can easily identify each webhook.

  • URL - This is where you want to send the webhook. Make sure that the URL begins with http:// or https://

  • Enabled - Determines whether webhook is enabled to run or not. This allows you to set up webhooks and easily turn them on or off as needed.

  • Method - WarmHub supports the following common webhook request methods:

    • Post

    • Get

    • Put

    • Delete

    • Patch

  • Event Name - This is the name of the event type that you want to trigger the webhook.

    • Commit Created

    • Instance Added

    • Instance Revised

    • Instance Retracted

  • Eligible Types - This is a multi-select option of the types available in your repo, that you would like to trigger the webhook.

  • Headers (optional) - Allow you to add any number of needed headers to your webhook request.

  • Secret (optional) - This accepts the HMAC (Hash-based Message Authentication Code) secret used to verify the authenticity and integrity of the webhook payload

Last updated