Create a webhook

POST

Create a webhook to be called when certain events occur.

Complete guide: Webhooks.

Request

This endpoint expects an object.
urlstringRequired>=1 character<=1024 characters

The URL of the webhook

eventslist of enumsRequired

A list of events that this webhook subscribes to

tokenstringOptional<=128 characters

A secret string used to authenticate the webhook. This value will be included in the X-Ntropy-Token header when sending requests to the webhook

Response

Successful Response

urlstring>=1 character<=1024 characters

The URL of the webhook

eventslist of enums

A list of events that this webhook subscribes to

idstring

A generated unique identifier for the webhook

created_atdatetime

The date and time when the webhook was created.

enabledboolean

Whether the webhook is enabled or not.

tokenstringOptional<=128 characters

A secret string used to authenticate the webhook. This value will be included in the X-Ntropy-Token header when sending requests to the webhook