Get pull endpoint

GET

/v1/pull-endpoints/{id}

• Production

Retrieve a pull endpoint with event counts.

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Pull endpoint identifier (UUIDv7)

Example

01935abc-def0-7123-4567-890abcdef012

Responses

200

Pull endpoint details

object

data

object

id

required

string format: uuid

name

string

description

string

mode

required

string

Allowed values: pull

ingest_url

required

URL to give to your webhook provider. Does not include the secret token suffix.

string format: uri

active

required

Whether the endpoint is active (not deleted).

boolean

paused

required

boolean

retention_days

integer

nullable

event_type_source

string

Allowed values: body header

event_type_path

string

counts

Event counts (only on single-endpoint GET, not list)

object

stored

integer

fetched

integer

delivered

integer

total

integer

verify_static_token

boolean

token_header_name

string

token_query_param

string

verify_hmac

boolean

hmac_header_name

string

timestamp_header_name

string

timestamp_ttl_seconds

integer

nullable

verify_ip_allowlist

boolean

allowed_cidrs

Array<string>

ingest_response_code

integer

idempotency_header_names

Array<string>

created_at

required

string format: date-time

updated_at

required

string format: date-time

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

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