Skip to main content
GET
/
webhooks
/
events
JavaScript
import Nuntly from '@nuntly/sdk';

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

// Automatically fetches more pages as needed.
for await (const eventListResponse of client.webhooks.events.list()) {
  console.log(eventListResponse.id);
}
{
  "data": [
    {
      "id": "<string>",
      "webhookId": "<string>",
      "orgId": "<string>",
      "event": "email.queued",
      "data": {},
      "status": "success",
      "successfulAt": "<string>"
    }
  ],
  "nextCursor": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer HTTP authentication. Allowed headers Authorization: Bearer <API_KEY>

Query Parameters

cursor
string

The cursor to retrieve the next page of results

limit
number
default:30

The maximum number of results to return

Required range: 1 <= x <= 30

Response

200 response

data
object[]
required

List of webhook events

nextCursor
string