Create a webhook

POST

Create a webhook to be called when certain events occur.

Complete guide: Webhooks.

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

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

1	curl -X "POST" \
2	"https://api.ntropy.com/v3/webhooks" \
3	-H "Accept: application/json" \
4	-H "X-API-KEY: cd1H...Wmhl" \
5	-H "Content-Type: application/json" \
6	-d '{
7	"url": "https://example.com:5689",
8	"events": [
9	"batches.completed",
10	"batches.error"
11	],
12	"token": "hunter2"
13	}'
14