Get inbound endpoint

GET

/v1/inbound-endpoints/{id}

• Production

Retrieve full details of a specific inbound endpoint including verification configuration and status.

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Inbound endpoint identifier (UUIDv7)

Example

01935abc-def0-7123-4567-890abcdef012

Responses

200

Inbound endpoint details retrieved successfully

object

data

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

object

id

Unique inbound endpoint identifier

string format: uuid

Example

01935abc-def0-7123-4567-890abcdef012

name

Endpoint name

string

Example

Stripe webhooks

description

Optional description

string

Example

Receives Stripe payment events

url

Forwarding URL

string format: uri

Example

https://myapp.com/webhooks/stripe

active

Whether the endpoint is active

boolean

Example

true

paused

Whether the endpoint is paused

boolean

verify_static_token

Static token verification enabled

boolean

verify_hmac

HMAC verification enabled

boolean

Example

true

verify_ip_allowlist

IP allowlist verification enabled

boolean

ingest_response_code

HTTP status code returned to senders

integer

Example

202

idempotency_header_names

Header names used for idempotency

Array<string>

Example

[]

signing_enabled

Whether delivery signing is enabled

boolean

created_at

string format: date-time

Example

2025-12-01T10:00:00Z

updated_at

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": "01935abc-def0-7123-4567-890abcdef012",
    "name": "Stripe webhooks",
    "description": "Receives Stripe payment events",
    "url": "https://myapp.com/webhooks/stripe",
    "active": true,
    "paused": false,
    "verify_static_token": false,
    "verify_hmac": true,
    "verify_ip_allowlist": false,
    "ingest_response_code": 202,
    "idempotency_header_names": [],
    "signing_enabled": false,
    "created_at": "2025-12-01T10:00:00Z",
    "updated_at": "2025-12-06T12:00:00Z"
  },
  "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"
  }
}