Retrieve webhook events
Returns the delivery log of a webhook, newest first: one entry per delivery, successful (webhook.sent.success) or failed (webhook.sent.error), with the payload…
Returns the delivery log of a webhook, newest first: one entry per delivery, successful (webhook.sent.success) or failed (webhook.sent.error), with the payload sent and the answer of your endpoint. Filter by status or date and paginate with offset and limit.
Authorization
api_key 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
Webhook id
Query Parameters
Offset for pagination
00 <= valueLimit for pagination
201 <= value <= 100Status of the events
"success" | "error"Date of the events
dateResponse Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v2/webhook/string/events"{
"events": [
{
"id": "evt_1234567890abcdef",
"organization_id": "org_1234567890abcdef",
"project_id": "proj_1234567890abcdef",
"type": "task.created",
"action_type": "plan_created",
"source_event_type": "routal.planner.2.plan.created",
"created_by": "user_1234567890abcdef",
"created_by_type": "admin",
"object_id": "obj_1234567890abcdef",
"object_id_type": "task",
"created_at": "2023-01-01T00:00:00Z",
"diff": {},
"snapshot": {},
"request_context": {},
"meta": {},
"data": {}
}
],
"hasNextPage": false,
"hasPreviousPage": true
}{
"message": "Domain not found",
"message_id": "highway.domain.error.not_found"
}{
"message": "Domain not found",
"message_id": "highway.domain.error.not_found"
}{
"message": "Domain not found",
"message_id": "highway.domain.error.not_found"
}