/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Get Webhook Delivery

Get Webhook Delivery

One outbound webhook delivery with its stored payload, request body and response body.

GET/v1/projects/{projectId}/webhook-deliveries/{deliveryId}Try it
Session token

Returns one outbound webhook delivery with what Syntext stored about it: the event payload, the body it sent and the body your endpoint answered with. Use it to debug a failed delivery or to check what a replay would send.

Note

Session JWT and org membership required. Any role can read deliveries — an API key gets 401, a non-member 403.

Any plan. Needs the Webhooks add-on enabled; otherwise 403 addon_disabled.

Path Parameters

NameDescription
projectId:stringpathRequired
The project ID.
deliveryId:stringpathRequired
The delivery ID, from GET /webhook-deliveries.

Response — 200 OK

The delivery is returned as delivery, not wrapped in data:

Response Fields

NameDescription
delivery.statusCode:integer | null
Your endpoint's HTTP status on the last attempt. null when no response arrived — a timeout, a network error, or a URL that failed the endpoint URL rules.
delivery.error:string | null
Why the delivery failed, e.g. HTTP 500 or the redirect or URL refusal reason. null on success.
delivery.replayOf:string | null
The delivery this one replayed, or null.
delivery.payload:object | null
The event data as sent, with secret-looking keys replaced by "[redacted]". null when the payload was over 64 KiB or the delivery predates stored payloads.
delivery.requestBody:string | null
The JSON body Syntext sent, as text, redacted the same way and cut at 16 KiB (ending in …[truncated]).
delivery.responseBody:string | null
Your endpoint's reply on the last attempt, cut at 16 KiB. null when there was no response body.
delivery.replayable:boolean
true when a payload is stored. Replaying also needs the endpoint to be active — see Replay Delivery.

The redaction rules are under What a delivery stores. Request headers, including the signature, are never stored.

Error Responses

401 Unauthorized

Missing, invalid or expired session JWT, or an API key.

403 Forbidden

You are not a member of the organization that owns the project (forbidden), or the Webhooks add-on is not enabled:

json
{
"error": {
"code": "addon_disabled",
"message": "The webhooks add-on is not enabled for this project",
"details": { "traceId": "6f1c2a9e-3b7d-4c11-9a0e-2d5f8b4c7e10" }
}
}

404 Not Found

The project does not exist, or there is no such delivery in this project — including an ID that is not a UUID. error.code is not_found.

Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c/webhook-deliveries/9d4e2b7a-6c1f-4a3e-8b5d-0f2a7c9e1b34 \
-H "Authorization: Bearer $SYNTEXT_JWT"
Responseapplication/json
200OK
{
"delivery": {
"id": "9d4e2b7a-6c1f-4a3e-8b5d-0f2a7c9e1b34",
"endpointId": "2c7f1e9a-4b3d-4e8f-9a6c-1d0e5b7a3f28",
"event": "build.failed",
"statusCode": 500,
"success": false,
"durationMs": 3412,
"error": "HTTP 500",
"replayOf": null,
"createdAt": "2026-11-08T10:15:02.000Z",
"payload": {
"buildId": "7e1a9c3d-5b2f-4d8e-a0c6-3f9b1e2d4a57",
"projectId": "3f6c1d2e-8a4b-4f7e-9c21-5b0d7e6a9f13",
"branch": "main",
"error": "MDX compile error in guides/setup.mdx",
"durationMs": 8120
},
"requestBody": "{\"event\":\"build.failed\",\"timestamp\":\"2026-11-08T10:15:02.000Z\",\"projectId\":\"3f6c1d2e-8a4b-4f7e-9c21-5b0d7e6a9f13\",\"data\":{\"buildId\":\"7e1a9c3d-5b2f-4d8e-a0c6-3f9b1e2d4a57\",\"projectId\":\"3f6c1d2e-8a4b-4f7e-9c21-5b0d7e6a9f13\",\"branch\":\"main\",\"error\":\"MDX compile error in guides/setup.mdx\",\"durationMs\":8120}}",
"responseBody": "upstream unavailable",
"replayable": true
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext