Skip to main content
Routal

Test a webhook

Sends a sample event of the chosen eventtype, with example data, to the webhook URL.

POST
/v2/webhook/{id}/test

Sends a sample event of the chosen event_type, with example data, to the webhook URL. Use it to check that your endpoint is reachable before relying on it. Test events carry no id and are not retried or recorded in the delivery log.

The request fails if your endpoint does not answer with a 2xx within 10 seconds.

Authorization

api_key
private_key<token>

Pass your API key as the private_key query string parameter. Generate and rotate keys in Developer Settings of your Routal workspace.

Keys stay server-side. Never ship them to a browser or mobile app.

In: query

Path Parameters

id*string

Webhook id

Match^[0-9a-f]{24}

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v2/webhook/string/test" \  -H "Content-Type: application/json" \  -d '{}'
{}
{
  "message": "Domain not found",
  "message_id": "highway.domain.error.not_found"
}
Empty
{
  "message": "Domain not found",
  "message_id": "highway.domain.error.not_found"
}
{
  "message": "Domain not found",
  "message_id": "highway.domain.error.not_found"
}
Empty
Empty