Verify webhook

Send a test event in order to verify your webhook endpoint, it needs to respond with HTTP 200 to be verified. Webhook needs to be verified before it will receive identification events.

POST /webhooks/{id}/verification

Verify webhook

cURL

curl --request POST \
  --url https://management-api.fpjs.io/webhooks/{id}/verification \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Version: <x-api-version>'

200

{
  "data": {
    "id": "wh_HYv9YfsIIUjpvR",
    "description": "My Webhook",
    "verified": false,
    "environment": {},
    "url": "https://website.com/webhook",
    "legacy": true,
    "basic_auth": {},
    "created_at": "2023-11-07T05:31:56Z",
    "signing_key": "<string>",
    "last_enabled_at": {},
    "last_disabled_at": {}
  },
  "environment": {}
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Version · string · required

Management API version.

Path Parameters

id · string · required

Webhook ID

Response

200

application/json

Webhook verification process initiated. Make sure webhook is active in order to receive identification events.

data · object · required

Show child attributes

environment · object · required

Environment ID this webhook is associated with. Null if global.