Get delivery
get
/v2/projects/{ref}/webhooks/deliveries/{id}Get details of a specific delivery attempt.
Path parameters
- refRequiredstring
Project ref
- idRequiredstring
Identifier of a delivery (UUID v7).
Response codes
- 200
- 401
- 403
- 404
- 408
- 429
- 500
Response (200)
{ "data": { "type": "delivery", "id": "00000000-0000-0000-0000-000000000000", "attributes": { "id": "00000000-0000-0000-0000-000000000000", "event_id": "00000000-0000-0000-0000-000000000000", "status": "pending", "response_code": -9007199254740991, "response_headers": { "property1": "lorem", "property2": "lorem" }, "response_body": { "property1": "lorem", "property2": "lorem" }, "error_code": "lorem", "error_message": "lorem", "attempt_timestamp": "4404-02-29T04:24Z", "event": { "type": "v1.project.paused", "payload": { "organization_slug": "tsrqponmlkjihgfedcba", "project_ref": "abcdefghijklmnopqrst" }, "timestamp": "4404-02-29T04:24Z" } } }}{ "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "const": "delivery", "description": "Resource type." }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Identifier of a delivery (UUID v7)." }, "attributes": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Identifier of a delivery (UUID v7)." }, "event_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Identifier of the event, which triggered the delivery (UUID v7)." }, "status": { "type": "string", "enum": [ "pending", "success", "failure", "skipped" ], "description": "Status of the delivery attempt." }, "response_code": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "HTTP status code of the response, `0` if unavailable." }, "response_headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" }, "description": "HTTP headers of the response, `{}` if unavailable." }, "response_body": { "anyOf": [ { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" }, "description": "Parsed JSON representation of an HTTP body of the response, `{}` if unavailable." }, { "type": "string", "description": "String representation of an HTTP body of the response." } ] }, { "type": "null" } ] }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "attempt_timestamp": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "description": "Timestamp of the attempt." }, "event": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "v1.project.paused", "v1.project.created", "v1.project.restored", "v1.project.transferred", "v1.project.removed", "v1.project.restarted", "v1.project.status.changed", "v1.project.backup.started", "v1.project.branch.created", "v1.project.branch.updated", "v1.project.branch.removed", "v1.project.secrets.leaked", "v1.organization.member.invitation.created", "v1.organization.member.invitation.canceled", "v1.organization.member.added", "v1.organization.member.removed", "v1.organization.member.role.assigned", "v1.organization.member.role.removed", "v1.organization.member.role.updated", "v1.organization.billing.plan.upgraded", "v1.organization.billing.plan.downgraded", "v1.organization.secrets.leaked" ], "description": "Webhook event type." }, "payload": { "type": "object", "properties": { "organization_slug": { "type": "string", "pattern": "^[\\w-]+$", "description": "Organization slug", "example": "tsrqponmlkjihgfedcba" }, "project_ref": { "anyOf": [ { "type": "string", "minLength": 20, "maxLength": 20, "pattern": "^[a-z]+$", "description": "Project ref", "example": "abcdefghijklmnopqrst" }, { "type": "null" } ] } }, "required": [ "organization_slug", "project_ref" ], "description": "Final data sent to the consumer." }, "timestamp": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "description": "Timestamp of event publication." } }, "required": [ "type", "payload", "timestamp" ] } }, "required": [ "id", "event_id", "status", "response_code", "response_headers", "response_body", "error_code", "error_message", "attempt_timestamp", "event" ] } }, "required": [ "type", "id", "attributes" ] } }, "required": [ "data" ]}