Skip to content

Get message details

GET
/v1/messages/{id}

Retrieve the status, metadata, and delivery information for a specific message

id
required
string format: uuid

Unique message identifier (UUIDv7)

Example
01935abc-def0-7123-4567-890abcdef012

Message details retrieved successfully

object
data
object
id

Unique message identifier (UUIDv7)

string format: uuid
Example
01935abc-def0-7123-4567-890abcdef012
project_id

Project that owns this message

string
Example
proj_abc123
endpoint_id

Endpoint ID for delivery

string
Example
ep_def456
status

Current message status:

  • queued: Waiting for initial delivery
  • delivering: Currently being delivered
  • succeeded: Successfully delivered
  • pending_retry: Waiting for scheduled retry
  • failed_permanent: All retries exhausted (in DLQ)
string
Allowed values: queued delivering succeeded pending_retry failed_permanent
Example
succeeded
attempt_count

Number of delivery attempts made

integer
Example
2
replay_count

Number of times this message has been manually replayed

integer
0
content_type

Content-Type header used for delivery

string
Example
application/json
size_bytes

Payload size in bytes

integer
Example
256
payload_sha256

SHA256 hash of the payload

string
Example
abc123def456...
idempotency_key

Idempotency key if provided

string
Example
order-12345-created-v1
next_attempt_at

Scheduled time for next retry attempt (if pending_retry)

string format: date-time
Example
2025-12-06T17:00:00Z
last_error

Error message from the last failed attempt

string
Example
connection timeout
response_status

HTTP status code from the most recent delivery attempt

integer
Example
200
response_latency_ms

Latency in milliseconds for the most recent delivery attempt

integer
Example
245
created_at

When the message was created

string format: date-time
Example
2025-12-06T12:00:00Z
updated_at

When the message was last updated

string format: date-time
Example
2025-12-06T12:01:30Z
meta
object
request_id

Unique identifier for this request (useful for support)

string
Example
req_xyz123
Example
{
"data": {
"id": "01935abc-def0-7123-4567-890abcdef012",
"project_id": "proj_abc123",
"endpoint_id": "ep_def456",
"status": "succeeded",
"attempt_count": 2,
"replay_count": 0,
"content_type": "application/json",
"size_bytes": 256,
"payload_sha256": "abc123...",
"response_status": 200,
"response_latency_ms": 245,
"created_at": "2025-12-06T12:00:00Z",
"updated_at": "2025-12-06T12:01:30Z"
},
"meta": {
"request_id": "req_xyz123"
}
}

Unauthorized - Invalid or missing API key

object
error
object
code

Machine-readable error code

string
Example
INVALID_REQUEST
message

Human-readable error message

string
Example
endpoint must be a valid HTTPS URL
meta
object
request_id

Unique identifier for this request (useful for support)

string
Example
req_xyz123
Example
{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
},
"meta": {
"request_id": "req_xyz123"
}
}

Resource not found

object
error
object
code

Machine-readable error code

string
Example
INVALID_REQUEST
message

Human-readable error message

string
Example
endpoint must be a valid HTTPS URL
meta
object
request_id

Unique identifier for this request (useful for support)

string
Example
req_xyz123
Example
{
"error": {
"code": "NOT_FOUND",
"message": "Message not found"
},
"meta": {
"request_id": "req_xyz123"
}
}
Personalize Examples

Enter your credentials to populate code examples throughout the docs.