Webhook Events

📘

Sandbox Only

The Webhook Events API is currently limited to sandbox only.

A webhook_event is an object that describes a notification for an event to a webhook endpoint. You can create a webhook_event to trigger a notification for an event to a particular webhook endpoint.

Attribute

Description

id
string

Unique identifier for the webhook. This is the "X-Webhook-ID" on a webhook notification header.

event_id
string

The ID of the Event object.

webhook_endpoint_id
string

The ID of the Webhook Endpoint object.

live_mode
boolean

This field will be true if this object exists in the live environment or false if it exists in the test environment.

{
  "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"
}