Get inbound message details

GET

/v1/inbound-messages/{id}

• Production

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

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Inbound message identifier (UUIDv7)

Example

01935abc-def0-7123-4567-890abcdef012

Responses

200

Inbound message details retrieved successfully

object

data

required

Full inbound message details

object

id

required

Unique inbound message identifier (UUIDv7)

string format: uuid

Example

01935abc-def0-7123-4567-890abcdef012

project_id

required

Project that owns this message

string

Example

proj_abc123

inbound_endpoint_id

required

Inbound endpoint that received this message

string format: uuid

Example

01935abc-def0-7123-4567-890abcdef099

status

required

Current message delivery status

string

Allowed values: queued delivering succeeded pending_retry failed_permanent

Example

succeeded

attempt_count

required

Number of delivery attempts made

integer

Example

1

replay_count

required

Number of times this message has been manually replayed

integer

0

content_type

Content-Type of the original inbound payload

string

Example

application/json

size_bytes

Payload size in bytes

integer

Example

512

payload_sha256

SHA256 hash of the payload

string

Example

abc123def456...

idempotency_key

Derived idempotency key (if configured on the inbound endpoint)

string

next_attempt_at

Scheduled time for next retry attempt (if pending_retry)

string format: date-time

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

120

queue_wait_ms

Time spent waiting in queue before first delivery attempt (ms)

integer

Example

50

total_delivery_ms

Total time from received to delivered (ms)

integer

Example

5000

received_at

required

When the inbound message was received

string format: date-time

Example

2025-12-06T12:00:00Z

updated_at

required

When the message was last updated

string format: date-time

Example

2025-12-06T12:00:05Z

delivered_at

When the message was successfully delivered

string format: date-time

Example

2025-12-06T12:00:05Z

failed_at

When the message permanently failed

string format: date-time

meta

required

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",
    "inbound_endpoint_id": "01935abc-def0-7123-4567-890abcdef099",
    "status": "succeeded",
    "attempt_count": 1,
    "replay_count": 0,
    "content_type": "application/json",
    "size_bytes": 512,
    "payload_sha256": "abc123...",
    "response_status": 200,
    "response_latency_ms": 120,
    "received_at": "2025-12-06T12:00:00Z",
    "updated_at": "2025-12-06T12:00:05Z",
    "delivered_at": "2025-12-06T12:00:05Z"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

400

Invalid request

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

Examples

Endpoint not found

{
  "error": {
    "code": "ENDPOINT_NOT_FOUND",
    "message": "endpoint not found"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Invalid endpoint ID format

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "endpoint_id must be in format ep_xxx"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Invalid payload

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "payload must be valid JSON"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Invalid headers

{
  "error": {
    "code": "INVALID_HEADERS",
    "message": "header 'Host' is forbidden and cannot be overridden"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

401

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"
  }
}

404

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"
  }
}

500

Internal server error

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": "INTERNAL_ERROR",
    "message": "An internal error occurred"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}