Create a webhook endpoint

POST/v1/webhooks

Registers an https URL for the events you choose. Answers 201 with the endpoint and its signing_secret, which signs every delivery. 400 for a URL that is not https.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

url*Url

Where the events are sent, as POST requests. Must be https:// (400 otherwise).

events*array<>

The event types to send to this endpoint, at least one.

Items1 <= items

description?|

Your note about the endpoint, up to 500 characters.

org_id?|

The organization the endpoint is for. Required when signed in; a secret key's own organization is used when it is left out.

Response Body

`application/json`

curl -X POST "https://example.com/v1/webhooks" \  -H "Content-Type: application/json" \  -d '{    "url": "string",    "events": [      "model.ready"    ]  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",  "url": "string",  "description": "string",  "events": [    "model.ready"  ],  "enabled": true,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "signing_secret": "string"}

{  "error": {    "code": "string",    "message": "string",    "details": null  }}

Create a webhook endpoint

Request Body

Response Body

201application/json

422application/json

`application/json`

`application/json`