Configuration, test and replay mutations return
WEBHOOKS_DISABLED while delivery is disabled. Authenticated GET routes keep returning retained events and delivery history for recovery.Authentication
Send
Authorization: Bearer YOUR_APPLICATION_SECRET_KEY. The key identifies the application, so you can’t choose a different owner in a request body.
A secret key grants control over its application’s webhook configuration. Dashboard role restrictions apply only to dashboard users, so don’t give application secret keys to read-only team members.
Operations
Create an endpoint
{ "endpoint": { ... }, "signing_secret": "whsec_..." }. The endpoint starts paused and unverified; you must verify it before enabling it.
Request conventions
Errors
Outages on Prava’s side return platform errors.
Recover events
Filter/v1/events with:
Keep the same filters while you advance
cursor. Events stay scoped to the authenticated application and environment.
Check queued delivery
For a non-financial check of queued delivery, activate the verified endpoint and send{ "type": "card_enrollment.completed", "queued": true } to the test route. It returns { "queued": true, "event_id": "evt_..." }; inspect delivery history for acceptance and retries.
Every synthetic payload has test: true and contains example data. This verifies delivery, not enrollment or financial provider behavior.
Endpoint health
Endpoint responses include a nullableblocked_reason. See Endpoint health reasons for RECEIVER_UNACKNOWLEDGED, DELIVERY_FAILURE_LIMIT, HTTP_GONE and DESTINATION_BLOCKED.
- Endpoints paused automatically for health keep new subscribed events within the original retry window.
- An explicit manual pause stops new events from being queued for that endpoint.