Skip to main content
POST
/
api
/
v1
/
webhook-endpoints
/
{id}
/
test
Send a test ping event to a webhook endpoint.
curl --request POST \
  --url https://api.backside.app/api/v1/webhook-endpoints/{id}/test \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "error_message": "<string>",
  "http_status": 1,
  "response_time_ms": 1
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Webhook endpoint ID

Response

Test result

​
success
boolean
required
​
error_message
string | null
​
http_status
integer<int32> | null
Required range: x >= 0
​
response_time_ms
integer<int64> | null
Required range: x >= 0