Skip to main content
POST
/
webhook
Receive Webhook Events
curl --request POST \
  --url https://api.example.com/webhook \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "event": "onboarding.updated",
  "data": {
    "status": "PENDING",
    "publicIdentifier": "<string>"
  }
}
'

Authorizations

​
x-api-key
string
header
required

API key required to receive webhooks.

Body

application/json
​
event
enum<string>

The type of webhook event.

Available options:
onboarding.updated
​
data
object

Response

Webhook received successfully.