Get message details

GET

/v1/messages/{id}

curl --request GET \
  --url https://api.hookbridge.io/v1/messages/01935abc-def0-7123-4567-890abcdef012 \
  --header 'Authorization: Bearer <token>'

• Production

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

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Unique message identifier (UUIDv7)

Example

01935abc-def0-7123-4567-890abcdef012

Responses

200

Message details retrieved successfully

Media typeapplication/json

object

data

object

id

Unique message identifier (UUIDv7)

string format: uuid

project_id

Project that owns this message

string

endpoint_id

Endpoint ID for delivery

string

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

attempt_count

Number of delivery attempts made

integer

replay_count

Number of times this message has been manually replayed

integer

content_type

Content-Type header used for delivery

string

size_bytes

Payload size in bytes

integer

payload_sha256

SHA256 hash of the payload

string

idempotency_key

Idempotency key if provided

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

response_status

HTTP status code from the most recent delivery attempt

integer

response_latency_ms

Latency in milliseconds for the most recent delivery attempt

integer

first_attempt_at

When the first delivery attempt was made

string format: date-time

nullable

delivered_at

When the message was successfully delivered

string format: date-time

nullable

processing_ms

Time spent processing the delivery (signing, headers, etc.)

integer

total_delivery_ms

Total time from message creation to successful delivery

integer

queue_wait_ms

Time spent waiting in the queue before first attempt

integer

retention_hours

How long this message’s payload is retained

integer

created_at

When the message was created

string format: date-time

updated_at

When the message was last updated

string format: date-time

deleted_at

When the message was soft-deleted. Only present on deleted rows.

string format: date-time

nullable

deleted_by_user_id

User ID that deleted the message (mutually exclusive with deleted_by_api_key_id).

string

nullable

deleted_by_api_key_id

API key ID that deleted the message (mutually exclusive with deleted_by_user_id).

string

nullable

meta

object

request_id

Unique identifier for this request (useful for support)

string

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

401

Unauthorized - Invalid or missing API key

Media typeapplication/json

object

error

object

code

Machine-readable error code

string

message

Human-readable error message

string

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

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

404

Resource not found

Media typeapplication/json

object

error

object

code

Machine-readable error code

string

message

Human-readable error message

string

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Message not found"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}