Webhook Events
The webhook event log holds every event recorded in the environment for at least one endpoint, with its deliveries and attempts, for 30 days. Endpoints are documented in Webhook Endpoints; the delivery format in Webhook Payloads.
Reading the log requires webhooks:read; redelivering requires webhooks:update.
Path Parameters
- Name
:env- Type
- string
- Description
Unique identifier of the environment.
- Name
:event- Type
- string
- Description
The event
id, for exampleevt_01JCX3Q9W2B5V7RZ0D4K6M8P1T.
Event Object
- Name
id- Type
- string
- Description
The event id:
evt_followed by 26 characters. The same value is sent asidin the envelope and as thewebhook-idheader.
- Name
type- Type
- string
- Description
The event type.
- Name
created_at- Type
- datetime
- Description
When the change was made.
- Name
test- Type
- boolean
- Description
truefor a test event.
- Name
collection_key- Type
- string | null
- Description
The collection the event belongs to, or
null.
- Name
delivery_counts- Type
- object
- Description
Only in List Events. Number of the event's deliveries by status:
pending,succeeded,dead.
Attempt Object
- Name
id- Type
- string
- Description
Unique identifier of the attempt (a UUID).
- Name
delivery_id- Type
- string
- Description
The delivery the attempt belongs to.
- Name
endpoint- Type
- object
- Description
idof the endpoint anddeleted,trueonce the endpoint has been deleted.
- Name
created_at- Type
- datetime
- Description
When the attempt finished.
- Name
status_code- Type
- integer | null
- Description
HTTP status the endpoint answered with, or
nullwhen there was no response.
- Name
latency_ms- Type
- integer
- Description
Duration of the attempt in milliseconds.
- Name
error_class- Type
- string | null
- Description
timeout,connect,tls,redirect(a3xxanswer; redirects are not followed) orblocked_address(the URL resolved to an address that is not allowed).nullwhen the endpoint answered with a status code and no other error.
- Name
response_excerpt- Type
- string
- Description
The first 1 KB of the response body. Empty for redirects and failed connections.
List Events
Lists events of the last 30 days, newest first, with delivery_counts.
Success Response: 200 OK
Query Parameters
- Name
type- Type
- string
- Description
Only events of this type.
- Name
endpoint- Type
- string
- Description
Only events with a delivery to this endpoint (its
id).
- Name
status- Type
- string
- Description
Only events with at least one delivery in this status:
pending,succeededordead. Combined withendpoint, the delivery to that endpoint.
- Name
test- Type
- string
- Description
truefor test events only,falseto leave them out.
- Name
after- Type
- datetime
- Description
Only events at or after this time (ISO 8601; without a zone, UTC).
- Name
before- Type
- datetime
- Description
Only events before this time.
- Name
limit- Type
- integer
- Default
- default:100
- Description
Items per page, at most 200.
- Name
offset- Type
- integer
- Default
- default:0
- Description
Items to skip. See Pagination.
Errors
- Name
400 Bad Request- Description
invalid_field-endpointis not a UUID,statusortesthas another value, orafter/beforeis not an ISO 8601 datetime
Request
curl https://api.foxnose.net/v1/7c9h4pwu/webhooks/events/ \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiI..."
Response
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "evt_01JCX3Q9W2B5V7RZ0D4K6M8P1T",
"type": "revision.published",
"created_at": "2026-11-12T09:41:07.512000+00:00",
"test": false,
"collection_key": "mK8nP3tYvBcX",
"delivery_counts": { "pending": 1, "succeeded": 1, "dead": 0 }
}
]
}
Retrieve Event
Returns one event with its envelope and all its deliveries, oldest first.
envelope is the event as a References only endpoint receives it. Content snapshots are never returned here, whatever the payload mode of the endpoints.
Success Response: 200 OK
Errors
- Name
404 Not Found- Description
webhook_event_not_found- no such event in the environment within the last 30 days
Request
curl https://api.foxnose.net/v1/7c9h4pwu/webhooks/events/evt_01JCX3Q9W2B5V7RZ0D4K6M8P1T/ \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiI..."
Response
{
"id": "evt_01JCX3Q9W2B5V7RZ0D4K6M8P1T",
"type": "revision.published",
"created_at": "2026-11-12T09:41:07.512000+00:00",
"test": false,
"collection_key": "mK8nP3tYvBcX",
"envelope": {
"id": "evt_01JCX3Q9W2B5V7RZ0D4K6M8P1T",
"type": "revision.published",
"version": 1,
"timestamp": "2026-11-12T09:41:07.512Z",
"test": false,
"environment": { "key": "7c9h4pwu", "project": "p9x8y7z6" },
"data": {
"collection": { "key": "mK8nP3tYvBcX" },
"resource": { "key": "r5tGh2kLmN9q" },
"revision": { "key": "rv8JkL2mNpQ4", "number": 3, "status": "published", "...": "..." },
"links": {
"resource": "https://api.foxnose.net/v1/7c9h4pwu/collections/mK8nP3tYvBcX/resources/r5tGh2kLmN9q/",
"revision": "https://api.foxnose.net/v1/7c9h4pwu/collections/mK8nP3tYvBcX/resources/r5tGh2kLmN9q/revisions/rv8JkL2mNpQ4/"
}
}
},
"deliveries": [
{
"id": "9b1e7c42-5d3a-4f8e-b2c6-7a0d1e9f3c85",
"endpoint": { "id": "3f6c2a8e-91d4-4b7a-a5e2-0c9d8b7f1e23", "deleted": false },
"status": "pending",
"attempts": 2,
"last_status_code": 503,
"last_error": null,
"created_at": "2026-11-12T09:41:07.530114+00:00",
"finished_at": null,
"next_attempt_at": "2026-11-12T09:41:28.902311+00:00"
}
]
}
List Event Attempts
Lists every attempt to deliver the event, across endpoints, oldest first.
Success Response: 200 OK
Query Parameters
- Name
limit- Type
- integer
- Default
- default:100
- Description
Items per page, at most 200.
- Name
offset- Type
- integer
- Default
- default:0
- Description
Items to skip.
Errors
- Name
404 Not Found- Description
webhook_event_not_found
Request
curl https://api.foxnose.net/v1/7c9h4pwu/webhooks/events/evt_01JCX3Q9W2B5V7RZ0D4K6M8P1T/attempts/ \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiI..."
Response
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": "0d5f8b3e-6a2c-4e9d-a7b1-3c8e2f6d9a40",
"delivery_id": "9b1e7c42-5d3a-4f8e-b2c6-7a0d1e9f3c85",
"endpoint": { "id": "3f6c2a8e-91d4-4b7a-a5e2-0c9d8b7f1e23", "deleted": false },
"created_at": "2026-11-12T09:41:08.011245+00:00",
"status_code": null,
"latency_ms": 10003,
"error_class": "timeout",
"response_excerpt": ""
},
{
"id": "7e2a9c4d-1b8f-4d6a-9e3c-5a0b7d2f8c61",
"delivery_id": "9b1e7c42-5d3a-4f8e-b2c6-7a0d1e9f3c85",
"endpoint": { "id": "3f6c2a8e-91d4-4b7a-a5e2-0c9d8b7f1e23", "deleted": false },
"created_at": "2026-11-12T09:41:13.640981+00:00",
"status_code": 503,
"latency_ms": 212,
"error_class": null,
"response_excerpt": "upstream unavailable"
}
]
}
Redeliver Event
Sends the event again as a new delivery, due immediately, with the same event id.
With endpoint_id, the event goes to that endpoint. Without it, the event goes to every endpoint that had a delivery of it and is active and subscribed to it at the time of the call; the others are listed in skipped with a reason: deleted, paused, disabled or endpoint_not_subscribed.
An endpoint is subscribed when the event's type is in its event_types and its collection filter admits the event's collection. A test event can be redelivered only to the endpoint it was sent to.
Success Response: 202 Accepted
Request Body
- Name
endpoint_id- Type
- string
- Description
Redeliver to this endpoint only.
Response
- Name
event_id- Type
- string
- Description
The event id.
- Name
deliveries- Type
- array
- Description
The new deliveries:
idandendpoint_id.
- Name
skipped- Type
- array
- Description
Endpoints not redelivered to:
endpoint_idandreason.
Errors
- Name
400 Bad Request- Description
invalid_field-endpoint_idis not a UUID
- Name
404 Not Found- Description
webhook_event_not_foundwebhook_endpoint_not_found-endpoint_idnames no endpoint of the environment
- Name
409 Conflict- Description
endpoint_not_active- the endpoint is paused, disabled or deleted (detail.reason), or, withoutendpoint_id, no endpoint can receive the event (detail.skipped)endpoint_not_subscribed- the endpoint's event types or collection filter do not cover the event
Request
curl -X POST https://api.foxnose.net/v1/7c9h4pwu/webhooks/events/evt_01JCX3Q9W2B5V7RZ0D4K6M8P1T/redeliver/ \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiI..." \
-H "Content-Type: application/json" \
-d '{"endpoint_id": "3f6c2a8e-91d4-4b7a-a5e2-0c9d8b7f1e23"}'
Response
{
"event_id": "evt_01JCX3Q9W2B5V7RZ0D4K6M8P1T",
"deliveries": [
{ "id": "2a7d4f9c-8e1b-4c3a-b6d5-9f0e2a8c7b13", "endpoint_id": "3f6c2a8e-91d4-4b7a-a5e2-0c9d8b7f1e23" }
],
"skipped": [
{ "endpoint_id": "5c9e1a7b-3d2f-4b8a-8c6e-1f4d7a0b9e52", "reason": "paused" }
]
}
List Event Types
Returns the catalogue of event types. Each type has a description, collection_scoped (true when every event of the type belongs to a collection; a file.* event belongs to one only when its file does) and a JSON Schema of its data for each payload mode in schemas.references and schemas.content. The list is not paginated.
Success Response: 200 OK
Request
curl https://api.foxnose.net/v1/7c9h4pwu/webhooks/event-types/ \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiI..."
Response
{
"results": [
{
"name": "resource.created",
"description": "A resource is created.",
"collection_scoped": true,
"schemas": {
"references": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": { "collection": { "...": "..." }, "resource": { "...": "..." }, "links": { "...": "..." } }
},
"content": { "...": "..." }
}
}
]
}