Documentation menu
API reference

Webhooks

webhook

Webhooks, their deliveries and test events.

The webhook object

objectstring
The object's type. Always webhook.
idstring
Unique identifier for the object.
namestring
The webhook's name. Null when none was given.
urlstring
The URL deliveries are sent to.
event_typearray of one of permit.created, case.createds
The event types delivered to this webhook.
activeboolean
Whether events are delivered. While false, deliveries are held.
secret_fingerprintstring
A fingerprint of the signing secret, for telling secrets apart.
retry_policyobject
How failed deliveries are retried.
Show fields
max_attemptinteger
Maximum attempts per delivery, between 1 and 20. Defaults to 12.
backoffone of exponential, linear, fixed
How the wait between attempts grows. One of exponential (doubles), linear (adds base_seconds) or fixed. No wait exceeds six hours. Defaults to exponential.
base_secondsinteger
Seconds to wait after the first failed attempt, between 1 and 3600. Defaults to 60.
jitterboolean
Whether each wait is randomized to between half and all of its length. Defaults to true.
dead_letter_after_hoursinteger
Hours after the event after which retries stop, between 1 and 720. Defaults to 24.
created_attimestamp
Time at which the object was created.
updated_attimestamp
Time at which the object was last updated.
hrefstring
The path of this webhook.

Endpoints

Next steps

GET /event_type

List event types

Continue