Webhooks

Webhooks are one method you can connect agents (our word for applications, LLMs or any other automated process) to your WarmHub repo.

Setting up a Webhook

If you are the owner of a repo, you can create a new webhook for your repo by clicking the "Create Webhook" button in the upper right hand corner of the webhooks page of your repo.

After doing so, a modal will appear where you can configure your webhook:

Option	Description
Name	The name of your webhook. Used for identification within your repo.
URL	The link to which this webhook will make the request. Supported protocols are HTTP and HTTPS, so the URL must begin with http:// or https://.
Enabled	Determines whether this webhook is enabled or not, allowing you to set up webhooks and easily turn them on or off as desired.
Method	The HTTP method which the webhook should use. The allowable methods are POST, GET, PUT, DELETE, and PATCH.
Event Name	The name of the WarmHub event on which the webhook should trigger. For more information, see Webhooks. The allowable events are: Commit Created Instance Added Instance Revised Instance Retracted Instance Reproduced Instance Replicated
Eligible Types	A multi-select filter determining on which ones of your WarmHub types this webhook should trigger. Additionally, there is an option for "All" to select all types defined in your repo.
Headers	(optional) Add headers to the request to be sent by the webhook.
Secret	(optional) The Hash-based Message Authentication Code secret used to confirm the authenticity and integrity of the webhook payload.

Webhook Body Structure

Based on the selected Event Name, the webhook will pass along different bodies in its response. For all Event Names, the body is JSON-like.

Event Name	Structure of JSON Body
Commit Created	payload: A link to the $wref of your commit
Instance Added	$wid: The $wid of the instance just added type: The type URI of the instance just added
Instance Revised	$wid: The $wid of the instance just revised type: The type URI of the instance revisedWref: The $wref of the originally revised instance
Instance Retracted	$wref: The $wref of the instance just retracted
Instance Reproduced	reproduced: The $wref of the assertion which has been reproduced reproduction: The $wid pointing to the reproduction instance
Instance Replicated	replicated: The $wref of the assertion which has been replicated replication: The $wid pointing to the replication instance