The Webhooks object

A webhook endpoint configuration. The HMAC-SHA256 signing secret is disclosed exactly twice: in the create response and in the rotate response. Every read surface carries secretHint instead.

Attributes

idstring

Integer identifier for the endpoint.

urlstring

HTTPS URL that receives webhook deliveries.

descriptionstring

Optional human-readable label for the endpoint.

secretHintstring

Last four characters of the signing secret, for identification. The full secret is shown only when created or rotated.

eventsstring

Array of subscribed event types.

isActivestring

Whether the endpoint is currently receiving deliveries.

createdAtstring

ISO 8601 creation timestamp.

updatedAtstring

ISO 8601 last modification timestamp.

stats24hstring

Delivery statistics for the last 24 hours: total, delivered, failed.

The Webhooks Objectjson

{
  "id": 3,
  "url": "https://example.com/webhooks/speybooks",
  "description": "Production webhook handler",
  "secretHint": "f6a1",
  "events": [
    "invoice.created",
    "invoice.paid",
    "payment.received"
  ],
  "isActive": true,
  "stats24h": {
    "total": 15,
    "delivered": 14,
    "failed": 1
  }
}