curl --request GET \
--url https://apix.spotzee.com/api/client/webhooks \
--header 'Authorization: Bearer <token>'{
"results": [
{
"id": 17,
"project_id": 42,
"name": "Order events to billing service",
"url": "https://api.example.com/spotzee/webhooks",
"status": "active",
"event_types": [
"delivery.delivered",
"delivery.failed"
],
"has_secret": true,
"created_at": "<string>",
"updated_at": "<string>",
"description": "<string>"
}
],
"nextCursor": "<string>",
"prevCursor": "<string>",
"limit": 123
}Returns a paginated list of webhook endpoints in the project, ordered by created_at descending by default. The plaintext signing secret is never returned — only has_secret indicates whether one is configured.
curl --request GET \
--url https://apix.spotzee.com/api/client/webhooks \
--header 'Authorization: Bearer <token>'{
"results": [
{
"id": 17,
"project_id": 42,
"name": "Order events to billing service",
"url": "https://api.example.com/spotzee/webhooks",
"status": "active",
"event_types": [
"delivery.delivered",
"delivery.failed"
],
"has_secret": true,
"created_at": "<string>",
"updated_at": "<string>",
"description": "<string>"
}
],
"nextCursor": "<string>",
"prevCursor": "<string>",
"limit": 123
}Documentation Index
Fetch the complete documentation index at: https://docs.spotzee.com/llms.txt
Use this file to discover all available pages before exploring further.
Project-scoped secret API key (sk_…). Pass in the Authorization: Bearer <key> header. Grants access to the project the key was issued for.
Opaque cursor returned by a previous page response. Omit on the first request.
Direction to walk relative to cursor. Defaults to next when omitted.
next, prev Maximum results per page. Use -1 to request all (rate-limited; large pages may be rejected).
-1 <= x <= 10025
Field to sort by. Defaults vary per resource.
"created_at"
Sort direction. Defaults vary per resource.
asc, desc Free-text search across the resource’s indexed fields.
A page of webhook endpoints.
Paginated response of WebhookEndpointList.
Page of results, ordered per the request’s sort and direction.
Hide child attributes
Numeric webhook endpoint identifier.
17
Identifier of the owning project.
42
Human-readable name shown in dashboards.
"Order events to billing service"
HTTPS URL the signed event payload will be POSTed to.
"https://api.example.com/spotzee/webhooks"
Lifecycle state of the endpoint. active receives events; inactive is paused by the user; disabled was suspended by the system after repeated delivery failures.
active, inactive, disabled "active"
Events the endpoint is subscribed to.
Event the endpoint is subscribed to. Each event identifies a queue, delivery, reputation, or infrastructure signal. See the events reference for full descriptions.
queue.queue-message-authenticated, queue.rescheduled, queue.quota-exceeded, delivery.concurrency-limit-exceeded, delivery.attempt-start, delivery.attempt-end, delivery.completed, delivery.delivered, delivery.dsn-perm-fail, delivery.dsn-temp-fail, delivery.failed, delivery.mail-from-rejected, delivery.message-rejected, delivery.rcpt-to-rejected, delivery.rcpt-to-failed, delivery.mx-lookup-failed, delivery.ip-lookup-failed, delivery.null-mx, delivery.connect-error, delivery.greeting-failed, delivery.ehlo-rejected, delivery.start-tls-error, delivery.start-tls-unavailable, delivery.implicit-tls-error, incoming-report.abuse-report, incoming-report.fraud-report, incoming-report.virus-report ["delivery.delivered", "delivery.failed"]
Whether a signing secret is currently configured. The plaintext secret itself is only returned on create and on rotate — never re-fetched.
Time the endpoint was created. ISO 8601.
Time the endpoint was last modified. ISO 8601.
Optional free-text note describing the endpoint.
Opaque cursor for the next page. null when no further pages exist.
Opaque cursor for the previous page. null when on the first page.
Page size used to build this response.
Was this page helpful?