Skip to main content
PATCH
/
apps
/
{client_id}
/
webhook_config
curl -X PATCH \
  -H "Authorization: Bearer sk_workspace_test_..." \
  -H "Content-Type: application/json" \
  -d '{"events":["verification.completed","verification.failed"],"retryAttempts":3,"timeoutSeconds":10}' \
  "https://sandbox.api.hopae.com/connect/v1/apps/abc123/webhook_config"

{
  "url": "https://hooks.example.com/hopae",
  "enabled": true,
  "retryAttempts": 3,
  "timeoutSeconds": 10,
  "secret": "",
  "events": [
    "verification.initiated",
    "verification.completed",
    "verification.awaiting_user_action",
    "verification.failed",
    "verification.expired",
    "verification.cancelled"
  ],
  "_id": "69c645e5756d7730ebef70ba"
}
Partially updates webhook delivery settings for an app.

​
Request

​
Authorization
string
required
Bearer <API_KEY> from Console > Developers > Workspace API Keys.
​
Content-Type
string
application/json

​
Path parameters

​
client_id
string
required
Client identifier of the app.

​
Request body

​
url
string
Destination URL for webhook delivery.
​
enabled
boolean
Toggle webhook delivery.
​
retryAttempts
number
Maximum retry attempts per event.
​
timeoutSeconds
number
Timeout in seconds per delivery attempt.
​
secret
string
Webhook signing secret.
​
events
string[]
Subscribed webhook events. Allowed values: verification.initiated, verification.completed, verification.awaiting_user_action, verification.failed, verification.expired, verification.cancelled.

​
Response

Returns the updated webhook configuration. 
curl -X PATCH \
  -H "Authorization: Bearer sk_workspace_test_..." \
  -H "Content-Type: application/json" \
  -d '{"events":["verification.completed","verification.failed"],"retryAttempts":3,"timeoutSeconds":10}' \
  "https://sandbox.api.hopae.com/connect/v1/apps/abc123/webhook_config"

{
  "url": "https://hooks.example.com/hopae",
  "enabled": true,
  "retryAttempts": 3,
  "timeoutSeconds": 10,
  "secret": "",
  "events": [
    "verification.initiated",
    "verification.completed",
    "verification.awaiting_user_action",
    "verification.failed",
    "verification.expired",
    "verification.cancelled"
  ],
  "_id": "69c645e5756d7730ebef70ba"
}
Webhooks are signed via HMAC-SHA256 using the app’s webhook secret.