List Webhook Endpoints

GET/v2/webhook-endpoints

Authorization

AuthorizationBearer token · headerrequired

Merchant API key scoped to one merchant and environment. Read operations require api:read, normal write operations require api:write, and broadcast mutations also require explicit broadcasts:write.

Query parameters

limitinteger

min 1 · max 100 · default: 25

cursorstring

min length 1

scopestring

Allowed:organizationsandboxproduction

statusstring | any

default: "enabled"

Header parameters

x-request-idstring

Optional caller-provided request correlation ID.

min length 1

Responses

200OK

nextCursorstring | anyrequired

Show properties

Any of:

string

string

any

any

endpointsobject[]required

Show properties

Array of object

idstring<uuid>required

merchantIdstring<uuid>required

scopestringrequired

Allowed:organizationsandboxproduction

environmentstring | anyrequired

Show properties

Any of:

string

string

any

any

namestringrequired

min length 1 · max length 160

urlstring<uri>required

statusstringrequired

Allowed:enableddisableddeleted

selectedEventTypesstring[]required

min items 1

revisionintegerrequired

min -9007199254740991 · max 9007199254740991

secretVersionobject | anyrequired

Show properties

Any of:

object

versionintegerrequired

min -9007199254740991 · max 9007199254740991

encryptionKeyIdstringrequired

min length 1 · max length 128

algorithmanyrequired

aadVersionanyrequired

purposeanyrequired

overlapExpiresAtstring<date-time> | anyrequired

Show properties

Any of:

string<date-time>

string<date-time>

any

any

any

any

deletedAtstring<date-time> | anyrequired

Show properties

Any of:

string<date-time>

string<date-time>

any

any

createdAtstring<date-time>required

updatedAtstring<date-time>required

401Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

403Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

404Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

409Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

422Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

429Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

500Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

Request

curl -X GET "https://api.cipay.net/v2/webhook-endpoints" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.cipay.net/v2/webhook-endpoints", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

Response

{
  "nextCursor": "string",
  "endpoints": [
    {
      "id": "<uuid>",
      "merchantId": "<uuid>",
      "scope": "organization",
      "environment": "sandbox",
      "name": "string",
      "url": "<uri>",
      "status": "enabled",
      "selectedEventTypes": [
        "member.invited"
      ],
      "revision": 0,
      "secretVersion": {
        "version": 0,
        "encryptionKeyId": "string",
        "algorithm": "aes-256-gcm",
        "aadVersion": 1,
        "purpose": "outbound_webhook_signing_secret",
        "overlapExpiresAt": "2024-01-01T00:00:00Z"
      },
      "deletedAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ]
}