v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

Create Webhook Endpoint

Create a new webhook endpoint

post/webhook_endpoints

Request body

urlstring

url must be configured like: https://<your-domain.com>

configured_eventsobject

A json object in the form of { topic => [event, …] }. When not specified, all events are sent to the Webhooks Endpoint. Refer to Webhooks for a list of topics and events.

Response

201

idstring

objectstring

live_modeboolean

urlstring

configured_eventsobject

webhook_keystring

enabledboolean

{"stackTrail":"paths:/webhook_endpoints:post:responses:201:content:application/json:schema:properties:discarded_at","oasType":"schema","type":"unknown"}

created_atstring

updated_atstring

Example response

{
  "id": "281686a8-359c-451a-b43c-76e2eec0037a",
  "object": "webhook_endpoint",
  "url": "https://<your-domain.com>",
  "webhook_key": "<webhook key>",
  "enabled": true,
  "created_at": "2022-02-16T02:22:31Z",
  "updated_at": "2022-02-16T02:22:31Z"
}