List webhook endpoints

GET

/v1/webhook_endpoints

const url = 'https://api.example.com/v1/webhook_endpoints?limit=10';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.example.com/v1/webhook_endpoints?limit=10' \
  --header 'Authorization: Bearer <token>'

Your endpoints in this key’s mode.

Authorizations

AccessToken

Parameters

Query Parameters

limit

integer

default: 10 >= 1 <= 100

How many objects to return, from 1 to 100.

cursor

string

A next_cursor from the previous page.

Responses

200

A page of endpoints.

application/json

object

object

required

string

Allowed value: list

data

required

Array

has_more

required

boolean

next_cursor

required

Pass back as cursor for the next page. null on the last page.

string | null

data

required

Array<object>

object

string

object

string

Allowed value: webhook_endpoint

url

string format: uri

enabled_events

Array<string>

status

string

Allowed values: enabled disabled

secret

The signing secret, whsec_.... Returned on create and rotate only.

string

livemode

boolean

created

A Unix timestamp.

integer

Example

{
  "object": "list",
  "data": [
    {
      "id": "we_3f9a1c2b7d4e5f60718293a4",
      "object": "webhook_endpoint",
      "status": "enabled"
    }
  ]
}

401

authentication_failure: access_token_required when no token was sent, invalid_access_token when it is not valid, has expired, or is a client secret. Sent with a WWW-Authenticate: Bearer header, which adds error="invalid_token" when a token was sent.

application/json

object

error

required

object

type

required

string

Allowed values: validation_failure authentication_failure authorization_failure not_found conflict timeout_or_in_progress policy_rejection invariant_violation rate_limited dependency_failure

code

required

A stable name for this refusal. Branch on this, never on message.

string

message

required

For the developer reading a log. May be reworded.

string

param

required

The field or parameter at fault, when there is one.

string | null

request_id

required

string | null

Example

{
  "error": {
    "type": "validation_failure"
  }
}

403

authorization_failure with merchant_mismatch: a Merchant-Id header, query parameter or body field names a merchant or tenant other than the key’s.

application/json

object

error

required

object

type

required

string

Allowed values: validation_failure authentication_failure authorization_failure not_found conflict timeout_or_in_progress policy_rejection invariant_violation rate_limited dependency_failure

code

required

A stable name for this refusal. Branch on this, never on message.

string

message

required

For the developer reading a log. May be reworded.

string

param

required

The field or parameter at fault, when there is one.

string | null

request_id

required

string | null

Example

{
  "error": {
    "type": "validation_failure"
  }
}

404

not_found: resource_missing for an id this key cannot see, route_missing for a path that does not exist.

application/json

object

error

required

object

type

required

string

Allowed values: validation_failure authentication_failure authorization_failure not_found conflict timeout_or_in_progress policy_rejection invariant_violation rate_limited dependency_failure

code

required

A stable name for this refusal. Branch on this, never on message.

string

message

required

For the developer reading a log. May be reworded.

string

param

required

The field or parameter at fault, when there is one.

string | null

request_id

required

string | null

Example

{
  "error": {
    "type": "validation_failure"
  }
}

503

dependency_failure with service_unavailable: something on our side, or a payment network behind it, did not answer. This call only reads, so nothing was changed; retry.

application/json

object

error

required

object

type

required

string

Allowed values: validation_failure authentication_failure authorization_failure not_found conflict timeout_or_in_progress policy_rejection invariant_violation rate_limited dependency_failure

code

required

A stable name for this refusal. Branch on this, never on message.

string

message

required

For the developer reading a log. May be reworded.

string

param

required

The field or parameter at fault, when there is one.

string | null

request_id

required

string | null

Example

{
  "error": {
    "type": "validation_failure"
  }
}