Receive Webhook Events

curl --request POST \
  --url https://api.example.com/webhook \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "data": {
    "publicIdentifier": "<string>"
  }
}
'

POST

webhook

curl --request POST \
  --url https://api.example.com/webhook \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "data": {
    "publicIdentifier": "<string>"
  }
}
'

Authorizations

x-api-key

string

header

required

API key required to receive webhooks.

Body

application/json

OnboardingUpdated
ProfileCreated
SmartMatchCreated

event

enum<string>

The type of webhook event.

Available options:

onboarding.updated

data

object

Show child attributes

Response

Webhook received successfully.

Introduction