object Webhook
Fields
| Field | Type | Description |
|---|---|---|
id | String | Public API ID for this identifiable. |
legacy_id | BigInt | Numeric legacy ID for this identifiable; use only where legacy IDs are required. |
account_id | String | Public API account ID that identifies the related record. |
shop_name | String | Shop name for this webhook. |
name | String | Human-readable name for this webhook. |
url | String | URL for the URL resource. |
source | String | Source for this webhook. |
enabled | Boolean | Whether this webhook is enabled and can send events. |
health | CustomersWebhookHealth | Health for this webhook. |
created_at | ISODateTime | Created at as an ISO-8601 datetime, returned in UTC unless otherwise noted. |
updated_at | ISODateTime | Updated at as an ISO-8601 datetime, returned in UTC unless otherwise noted. |
last_enabled_change | ISODateTime | Last enabled change as an ISO-8601 datetime, returned in UTC unless otherwise noted. |
shared_signature_secret | String | This will only be returned once when the webhook is created. |
Referenced By
- CreateWebhookOutput Type
- DisableWebhookOutput Type
- EnableWebhookOutput Type
- UpdateUrlWebhookOutput Type
- WebhookEdge Type
Example
{
"id": "UmVjb3JkOjEyMzQ=",
"legacy_id": 1234,
"account_id": "QWNjb3VudDoxMjM0",
"shop_name": "Order Shipped Webhook",
"name": "Order Shipped Webhook",
"url": "https://example.com/resource",
"source": "shopify",
"enabled": true,
"health": "HEALTHY",
"created_at": "2026-07-09T15:30:00Z",
"updated_at": "2026-07-09T15:30:00Z",
"last_enabled_change": "2026-07-09T15:30:00Z",
"shared_signature_secret": "tok_123456"
}