The WebhookConfig object

Configuration for a webhook endpoint. Webhooks allow you to receive real-time notifications about events in your ZenPays account.

Fields

Field	Type	Description
id REQUIRED	string	Unique identifier for the webhook
url REQUIRED	string	URL to receive webhook notifications
events REQUIRED	string[]	Event types this webhook subscribes to
secret OPTIONAL	string	Secret for verifying webhook signatures
isActive REQUIRED	boolean	Whether the webhook is currently active
failureCount OPTIONAL	number	Number of consecutive delivery failures
lastDeliveryAt OPTIONAL	string	ISO 8601 timestamp of the last successful delivery
createdAt REQUIRED	string	ISO 8601 timestamp when the webhook was created
updatedAt REQUIRED	string	ISO 8601 timestamp when the webhook was last updated

Example

{
  "id": "obj_1a2b3c",
  "url": "string",
  "events": [],
  "secret": "string",
  "isActive": false,
  "failureCount": 1,
  "lastDeliveryAt": "2026-01-15T09:30:00Z",
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}