Skip to main content

List Webhooks

Retrieve a paginated list of configured webhooks.

Endpointโ€‹

GET /v1/webhooks

Authenticationโ€‹

Requires an API key with the webhooks:read scope.

Query Parametersโ€‹

ParameterTypeDefaultDescription
pageinteger1Page number
per_pageinteger15Items per page (max 100)

Responseโ€‹

Success (200 OK)โ€‹

{
"data": [
{
"id": 1,
"name": "Booking Notifications",
"url": "https://example.com/webhooks/bookings",
"events": ["booking.created", "booking.updated", "booking.cancelled"],
"is_active": true,
"failure_count": 0,
"last_triggered_at": "2026-01-15T10:30:00+00:00",
"created_at": "2025-06-01T00:00:00+00:00",
"updated_at": "2026-01-15T10:30:00+00:00"
},
{
"id": 2,
"name": "Payment Sync",
"url": "https://example.com/webhooks/payments",
"events": ["payment.received", "payment.refunded"],
"is_active": true,
"failure_count": 2,
"last_triggered_at": "2026-01-14T15:45:00+00:00",
"created_at": "2025-08-15T00:00:00+00:00",
"updated_at": "2026-01-14T15:45:00+00:00"
}
],
"meta": {
"current_page": 1,
"per_page": 15,
"total": 2,
"total_pages": 1,
"request_id": "req_abc123",
"timestamp": "2026-01-15T12:00:00+00:00"
}
}

Response Fieldsโ€‹

FieldTypeDescription
idintegerUnique webhook identifier
namestringWebhook name
urlstringEndpoint URL that receives events
eventsarrayList of subscribed event types
is_activebooleanWhether webhook is active
failure_countintegerConsecutive delivery failures
last_triggered_atstring|nullLast event sent (ISO 8601)
created_atstringISO 8601 datetime
updated_atstringISO 8601 datetime
Auto-Disable

Webhooks are automatically disabled after 10 consecutive delivery failures. The failure_count resets to 0 after a successful delivery.

Errorsโ€‹

StatusCodeDescription
401authentication_requiredNo API key provided
401invalid_api_keyInvalid API key
403insufficient_scopeAPI key lacks webhooks:read scope

Example Requestโ€‹

curl -X GET "https://app.equipdash.com/api/v1/webhooks" \
-H "Authorization: Bearer eqd_live_abc123xyz789..."