Test a webhook endpoint · BeaconBox docs

Request

curl -X POST https://api.beaconbox.eu/api/v1/webhook-endpoints/v55favd767qu/test \
  -H "Authorization: Bearer $BEACONBOX_API_KEY"

curl -X POST https://api.beaconbox.eu/api/v1/webhook-endpoints/v55favd767qu/test \
  -H "Authorization: Bearer $BEACONBOX_API_KEY"

client.webhook_endpoints.test(endpoint_id)

client.webhook_endpoints.test(endpoint_id)

$client->webhookEndpoints->test($endpointId)

$client->webhookEndpoints->test($endpointId)

Path parameters

Name	Type	Description
`public_id`	`string`

Response

Returns 200.

Field	Type	Description
`delivered`	`boolean`	True when the endpoint answered 2xx.
`status_code`	`integer \| null`	What the endpoint answered. Null when it could not be reached.
`error`	`string \| null`	What went wrong, in words meant for the person who pressed test.
`duration_ms`	`integer`	How long the endpoint took to answer.

Errors

Failures are { "error_code": "..." } with a stable dotted code. See Errors for the codes worth branching on and the three outcomes that look like failures and are not.