PLATFORM RC-77 Webhook delivery semantics (v1) (contract) (v1)

Download OpenAPI specification:

Contract-only delivery semantics and query endpoints. This document does not imply a runtime backend implementation.

v1 invariants:

delivery_id is stable per (endpoint_id, event_id)
attempt_number starts at 1 and increments per delivery_id
metadata-only API; payload bytes are not retrievable
retention: 30 days (metadata)

List webhook deliveries (metadata only)

query Parameters

endpoint_id	string <uuid>
event_id	string <uuid>
status	string (WebhookDeliveryStatus) Enum: "queued" "sent" "failed" "retrying" "abandoned"
created_at_gte	string <date-time>
created_at_lte	string <date-time>
limit	integer [ 1 .. 200 ]
cursor	string

header Parameters

X-Correlation-Id

required

string

Responses

Response samples

200

Content type

application/json

{"deliveries": [{"delivery_id": "9892f438-d31c-4ff2-bc84-146525b292ff",
"event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7",
"endpoint_id": "e9ce0d4f-d433-423d-9497-4c000544106c",
"attempt_number": 1,
"status": "queued",
"http_status": 0,
"error_code": "string",
"next_retry_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"next_cursor": "string",
"correlation_id": "string",
"audit_event_id": "string"
}

Delivery attempt detail (metadata only)

path Parameters

delivery_id

required

string <uuid>

header Parameters

X-Correlation-Id

required

string

Responses

Response samples

200

Content type

application/json

{"delivery": {"delivery_id": "9892f438-d31c-4ff2-bc84-146525b292ff",
"event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7",
"endpoint_id": "e9ce0d4f-d433-423d-9497-4c000544106c",
"attempt_number": 1,
"status": "queued",
"http_status": 0,
"error_code": "string",
"next_retry_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"retry_schedule": {"attempts": [{"attempt_number": 1,
"delay_seconds": 0
}
]
},
"correlation_id": "string",
"audit_event_id": "string"
}

List deliveries for an endpoint (convenience; metadata only)

path Parameters

endpoint_id

required

string <uuid>

query Parameters

event_id	string <uuid>
status	string (WebhookDeliveryStatus) Enum: "queued" "sent" "failed" "retrying" "abandoned"
created_at_gte	string <date-time>
created_at_lte	string <date-time>
limit	integer [ 1 .. 200 ]
cursor	string

header Parameters

X-Correlation-Id

required

string

Responses

Response samples

200

Content type

application/json

{"deliveries": [{"delivery_id": "9892f438-d31c-4ff2-bc84-146525b292ff",
"event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7",
"endpoint_id": "e9ce0d4f-d433-423d-9497-4c000544106c",
"attempt_number": 1,
"status": "queued",
"http_status": 0,
"error_code": "string",
"next_retry_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"next_cursor": "string",
"correlation_id": "string",
"audit_event_id": "string"
}