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

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

// Automatically fetches more pages as needed.
for await (const webhookListResponse of client.webhooks.list()) {
  console.log(webhookListResponse.id);
}
{
  "data": [
    {
      "id": "wh_01jne5c7gr2mhwrqg4zqwf48y2",
      "org_id": "org_01jh6jk82zjq9deye73h0mzcaq",
      "name": "My fist webhook",
      "endpoint_url": "https://webhook.site/12345678-1234-5678-1234-123456789012",
      "events": [
        "email.delivered",
        "email.sent"
      ],
      "status": "enabled",
      "created_at": "2025-03-03T14:08:22.552Z",
      "modified_at": "2025-03-03T14:08:22.552Z",
      "region": "eu-west-1",
      "kind": "webhook"
    }
  ],
  "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 webhooks registered in your organization

Example:
[
  {
    "id": "wh_01jne5c7gr2mhwrqg4zqwf48y2",
    "org_id": "org_01jh6jk82zjq9deye73h0mzcaq",
    "name": "My fist webhook",
    "endpoint_url": "https://webhook.site/12345678-1234-5678-1234-123456789012",
    "events": ["email.delivered", "email.sent"],
    "status": "enabled",
    "created_at": "2025-03-03T14:08:22.552Z",
    "modified_at": "2025-03-03T14:08:22.552Z",
    "region": "eu-west-1",
    "kind": "webhook"
  }
]
​
next_cursor
string | null
⌘I