List Webhooks

List all webhooks for a business.

GET /webhooks

JavaScript

JavaScript

import DodoPayments from 'dodopayments';

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

// Automatically fetches more pages as needed.
for await (const webhookDetails of client.webhooks.list()) {
  console.log(webhookDetails.id);
}

200

{
  "data": [
    {
      "created_at": "<string>",
      "description": "<string>",
      "id": "<string>",
      "metadata": {},
      "updated_at": "<string>",
      "url": "<string>",
      "disabled": true,
      "filter_types": [
        "<string>"
      ],
      "rate_limit": 1
    }
  ],
  "done": true,
  "iterator": "<string>",
  "prev_iterator": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit · integer<int32> | null

Limit the number of returned items

iterator · string | null

The iterator returned from a prior invocation

Response

200 - application/json

List of endpoints

data · Webhook Details · object[] · required

List of webhoooks

Show child attributes

done · boolean · required

true if no more values are to be fetched.

iterator · string | null

Cursor pointing to the next paginated object

prev_iterator · string | null

Cursor pointing to the previous paginated object