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

const client = new Nuntly({
  apiKey: 'My API Key',
});

// Automatically fetches more pages as needed.
for await (const eventListResponse of client.webhooks.events.list()) {
  console.log(eventListResponse.id);
}
{
  "data": [
    {
      "id": "<string>",
      "webhook_id": "<string>",
      "org_id": "<string>",
      "event": "email.delivered",
      "received_at": "2023-11-07T05:31:56Z",
      "data": {
        "id": "<string>",
        "created_at": "<string>",
        "type": "email.sent",
        "data": {
          "id": "<string>",
          "org_id": "<string>",
          "message_id": "<string>",
          "sent_at": "<string>",
          "enqueue_at": "<string>",
          "domain": "<string>",
          "domain_id": "<string>",
          "from": "<string>",
          "to": "<string>",
          "subject": "<string>",
          "send": {},
          "bulk_id": "<string>",
          "cc": "<string>",
          "bcc": "<string>",
          "reply_to": "<string>",
          "headers": [
            {
              "name": "<string>",
              "value": "<string>"
            }
          ],
          "tags": {}
        },
        "kind": "event"
      },
      "status": "success"
    }
  ],
  "next_cursor": "<string>"
}

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
number
default:10

The maximum number of items to return

Required range: 1 <= x <= 30
cursor
string

The cursor to use for pagination

Response

A successful response

data
object[]

The events sent by a webhook

next_cursor
string | null