List webhooks

Lists webhook registrations for the association resolved from the token.

GET /webhooks

List webhooks

cURL

curl --request GET \
  --url https://api.zeam.money/gw/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'x-zeam-auth: <api-key>'

200

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "type": "IntentInitiated",
      "isActive": true,
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "nextCursor": "<string>",
    "hasMore": true
  }
}

Authorizations

Authorization · string · header · required

Access token issued by POST /v1/auth/token.

x-zeam-auth · string · header · required

Application secret (the apiKey issued at registration), required on every request.

Query Parameters

limit · integer · default: 20

Maximum items per page. Values above 100 are treated as 100; a non-numeric or non-positive value is a 400.

Required range: 1 <= x <= 100

cursor · string

Opaque pagination cursor from a previous response.

Response

200

application/json

A page of webhook registrations.

data · object[] · required

Show child attributes

pagination · object · required

Show child attributes