Skip to main content
GET
Returns the webhook delivery configuration for an app.

Request

string
required
Bearer <API_KEY> from Console > Developers > Workspace API Keys.

Path parameters

string
required
Client identifier of the app.

Response

string
Destination URL for webhook delivery.
boolean
Whether webhooks are sent.
number
Stored configuration value. The delivery pipeline currently uses a workspace-wide default (3 attempts at 1s / 5s / 30s) rather than this per-app value. Per-app override is on the roadmap.
number
Stored configuration value. The delivery pipeline currently uses a workspace-wide default (10s). Per-app override is on the roadmap.
string
Webhook signing secret.
string[]
Subscribed webhook events. See the Webhook Event Types reference for the full list. Common values: verification.created, verification.completed, verification.failed, verification.session.timed_out, verification.workflow.cancelled.
string
Webhook config identifier.
Webhooks are signed via HMAC-SHA256 using the app’s webhook secret. Each delivery includes an X-Hopae-Signature header in the format t=<unix-timestamp>,v1=<hex-hmac-sha256>. See the Webhook Signature Verification guide for verification code and replay-protection recommendations.