API reference ยท Webhooks
/v1/webhook-endpoints/{endpoint_id}/deliveriesList deliveries.
Read
What was sent to the endpoint, newest first, with every try and what it answered.
Path parameters#
-
The endpoint.
Query parameters#
Responses#
200OK
-
The delivery.
-
Its endpoint.
-
The event sent (the same id when it is sent again).
-
The event's type.
-
Its account.
-
A test.
-
pending: waiting for its next try. failed: every try failed. canceled: the endpoint was disabled or deleted.
One of
pendingdeliveringdeliveredfailedcanceled -
Every try, oldest first.
Show 6 fields
-
Which try.
-
When.
-
What your endpoint answered; null when it could not be reached.
-
Why it failed, when it did (timeout, redirect, private_address, http_500, ...).
-
How long it took.
-
The start of the answer (up to 512 bytes).
-
-
When it is tried again.
-
When it was queued.
-
When your endpoint took it.
400A query or path parameter is out of range or the wrong kind.
{
"error": {
"type": "invalid_request",
"code": "invalid_parameter",
"message": "A parameter has a value this route does not take.",
"request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
"retryable": false,
"doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#invalid_parameter"
}
}401The request has no Authorization header.
{
"error": {
"type": "authentication",
"code": "missing_api_key",
"message": "No API key: send it as Authorization: Bearer <key>.",
"request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
"retryable": false,
"doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#missing_api_key"
}
}403The key only works from the addresses you listed.
{
"error": {
"type": "permission",
"code": "ip_not_allowed",
"message": "This address is not on the key's allowlist.",
"request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
"retryable": false,
"doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#ip_not_allowed"
}
}404The id is unknown, or belongs to another customer or environment.
{
"error": {
"type": "not_found",
"code": "webhook_endpoint_not_found",
"message": "No webhook endpoint with that id.",
"request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
"retryable": false,
"doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#webhook_endpoint_not_found"
}
}429A request budget is used up (details.scope says which).
{
"error": {
"type": "rate_limit",
"code": "rate_limited",
"message": "Too many requests: slow down.",
"request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
"retryable": true,
"doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#rate_limited"
}
}500An error we did not expect.
{
"error": {
"type": "server",
"code": "internal_error",
"message": "Something went wrong on our side.",
"request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
"retryable": true,
"doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#internal_error"
}
}503A service this call needs did not answer.
{
"error": {
"type": "server",
"code": "temporarily_unavailable",
"message": "This cannot be done right now. Try again in a moment.",
"request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
"retryable": true,
"doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#temporarily_unavailable"
}
}Errors#
Codes this endpoint can return. Match on the code, never on the message.