Skip to main content
POST
/
v1
/
webhooks
/
{subscription_id}
/
test
Test Webhook Subscription
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.topo.io/v1/webhooks/{subscription_id}/test', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "delivered": true,
  "error": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer API key issued from Settings โ†’ Developers.

Path Parameters

subscription_id
string<uuid>
required

ID of the subscription.

Response

200 - application/json

Successful Response

delivered
boolean
required

Whether the receiver accepted the test payload.

error
string | null
required

Failure reason when delivered is false.