The Webhook Object

Learn how the webhook object lets you receive event notifications at an endpoint URL you specify, for the set of event types you choose to subscribe to.

The webhook Object

• Properties
• Endpoints

Represents a webhook that enables you to receive notifications of events. When you create a webhook, specify the endpoint URL at which you want to receive events and the set of event types that you want to receive.

Webhook

A webhook resource.

{
  "event_types": ["device.connected", "device.disconnected"],
  "secret": "mySecret",
  "url": "https://example.com/webhook",
  "webhook_id": "ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1"
}

---

Properties

event_types List of Strings

Types of events that the webhook should receive.

---

secret String

Secret associated with the webhook.

---

url String

URL for the webhook.

---

webhook_id String

ID of the webhook.

---

Endpoints

/webhooks/create

Creates a new webhook.

/webhooks/delete

Deletes a specified webhook.

/webhooks/get

Gets a specified webhook.

/webhooks/list

Returns a list of all webhooks.

/webhooks/update

Updates a specified webhook.