object Webhook

Fields

FieldTypeDescription
idString

Public API ID for this identifiable.

legacy_idBigInt

Numeric legacy ID for this identifiable; use only where legacy IDs are required.

account_idString

Public API account ID that identifies the related record.

shop_nameString

Shop name for this webhook.

nameString

Human-readable name for this webhook.

urlString

URL for the URL resource.

sourceString

Source for this webhook.

enabledBoolean

Whether this webhook is enabled and can send events.

healthCustomersWebhookHealth

Health for this webhook.

created_atISODateTime

Created at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

updated_atISODateTime

Updated at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

last_enabled_changeISODateTime

Last enabled change as an ISO-8601 datetime, returned in UTC unless otherwise noted.

shared_signature_secretString

This will only be returned once when the webhook is created.

Referenced By

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