Get endpoint

GET

/v1/endpoints/{id}

• Production

Retrieve details of a specific endpoint. The signing secret is not included.

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string

/^ep_[a-f0-9]{32}$/

Endpoint identifier (ep_ prefix + 32 hex chars)

Example

ep_550e8400e29b41d4a716446655440000

Responses

200

Endpoint details retrieved successfully

object

data

Full endpoint details (returned by GET /endpoints/:id)

object

id

Unique endpoint identifier

string

Example

ep_550e8400e29b41d4a716446655440000

url

Webhook delivery URL

string format: uri

Example

https://customer.app/webhooks

description

Optional description

string

Example

Main production webhook

rate_limit_rps

Rate limit in requests per second

integer

Example

10

burst

Maximum burst size

integer

Example

20

headers

Custom headers for webhook requests

object

key

additional properties

string

paused

Whether the endpoint is paused. When paused, messages are accepted but not delivered.

boolean

created_at

When the endpoint was created

string format: date-time

Example

2025-12-01T10:00:00Z

updated_at

When the endpoint was last updated

string format: date-time

Example

2025-12-06T12:00:00Z

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

req_xyz123

Example

{
  "data": {
    "id": "ep_550e8400e29b41d4a716446655440000",
    "url": "https://customer.app/webhooks",
    "description": "Main production webhook",
    "rate_limit_rps": 10,
    "burst": 20,
    "headers": {
      "X-Custom-Header": "value"
    },
    "created_at": "2025-12-01T10:00:00Z",
    "updated_at": "2025-12-06T12:00:00Z"
  },
  "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"
  }
}