API Reference

Webhook Events

post
https://example.com/webhooks/digits

Digits sends this JSON request body to your configured webhook endpoint. Return any 2xx response to acknowledge receipt; the response body is ignored.

Body Params

WebhookEvent is the JSON request body delivered to a configured webhook endpoint.

Delivery requests include:

  • Content-Type: application/json
  • User-Agent: Digits-Webhooks/1.0
  • Webhook-Timestamp: <unix timestamp used in the signature payload>
  • Webhook-Signature: v1=<hex HMAC SHA-256 signature>

The signature payload is {Webhook-Timestamp}.{raw_request_body}.

string
required

Event ID. Consumers should use this for idempotency.

string
required

Event type in the form <event_class>.<verb>, for example bill.created.

string
required

Public API version. Fixed to v1 for this contract.

date-time
required

Time the event originally occurred.

data
object
required

WebhookEventData contains the typed payload for a webhook event.

Responses
200

OK

Updated about 23 hours ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 23 hours ago