Sign in

v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

Create Webhook Event

Create a webhook event to schedule a notification for an event to a webhook endpoint.

post/webhook_events

Request body

webhook_endpoint_idstring required

A Webhook Endpoint ID for the endpoint to send the webhook notification

event_idstring required

An Event ID for the event you want to send in the webhook notification

Response

200

idstring
objectstring
live_modeboolean
event_idstring
webhook_endpoint_idstring
created_atstring
updated_atstring

Example response

{
  "id": "d785c973-68b1-49c7-81b8-cb35ae08539c",
  "object": "webhook_event",
  "live_mode": true,
  "event_id": "f945f814-06f4-45fa-9ccc-7344da475d6b",
  "webhook_endpoint_id": "d6c1e77f-f75e-4ef4-9447-0af510073c55",
  "created_at": "2022-02-15T01:42:33Z",
  "updated_at": "2022-02-15T01:42:33Z"
}