List webhook subscriptions

Lists all webhook subscriptions that are registered for the merchant. The results are paginated and provided in chronological order.

POST /api/service/webhook-subscription/list

JavaScript

JavaScript

import Ivy from '@getivy/node-sdk';

const client = new Ivy({
  apiKey: process.env['IVY_API_KEY'], // This is the default and can be omitted
});

const subscriptions = await client.webhook.subscription.list();

console.log(subscriptions.count);

200

{
  "items": [
    {
      "id": "<unknown>",
      "merchant": "<unknown>",
      "merchantApp": "<unknown>",
      "url": "<string>",
      "events": [],
      "createdAt": "<unknown>",
      "updatedAt": "<unknown>"
    }
  ],
  "skip": 1,
  "hasNext": true,
  "count": 0
}

Authorizations

X-Ivy-Api-Key · string · header · required

API key for authentication

Body

application/json

limit · number

The maximum number of webhook subscriptions to return

Required range: 0 < x < 20

skip · number

The number of webhook subscriptions to skip

Required range: x > 0

Response

200 - application/json

Returns a list of webhook subscriptions.

items · object[] · required

Array of webhook subscription objects

Show child attributes

skip · number · required

The number of webhook subscriptions skipped

Required range: x > 0

hasNext · boolean · required

Whether there are more webhook subscriptions to retrieve

count · number · required

The total number of webhook subscriptions

Required range: x > -1