List webhooks | Resend API (unofficial showcase)

3 parameters

limitintegeroptional

The maximum number of webhooks to return.

afterstringoptional

A UUID pagination cursor; returns results after the specified webhook. Cannot be used with `before`.

beforestringoptional

A UUID pagination cursor; returns results before the specified webhook. Cannot be used with `after`.

1 status code

200Returns a results object with a `data` array of webhook information and a `has_more` value indicating whether additional results are available.

objectstringoptional

Type of the response object.

has_morebooleanoptional

Indicates if there are more results available.

dataarray<object>optional

Array containing webhook information.

Error handling

The after and before cursors cannot be used together. Each cursor, when provided, must be a valid UUID.

import { Client } from "@octridev/resend";

const client = new Client({
  baseUrl: "https://api.resend.com",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.webhooks.list({
  limit: 20,
  after: "example",
  before: "example",
});

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "id": "479e3145-dd38-476b-932c-529ceb705947",
      "endpoint": "https://webhook.example.com/handler",
      "events": [
        "email.sent"
      ],
      "status": "enabled",
      "created_at": "2023-10-06 23:47:56.678+00"
    }
  ]
}

Request

Response

Errors