Node.js SDK webhook client

Webhook endpoint methods require paubox-node 2.0.0 or later. They are on webhookService, not on emailService.

webhookService manages webhook endpoints through the Paubox webhooks service at https://api.paubox.com/v1/webhooks. It sends a scoped API key as Authorization: Bearer YOUR_API_KEY. The key’s scopes decide which events it can subscribe to.

Create the service

const paubox = require('paubox-node');
const webhooks = paubox.webhookService({ apiKey: 'YOUR_API_KEY' });

When apiKey is omitted, the service reads WEBHOOKS_API_KEY from process.env. Pass baseURL or set WEBHOOKS_BASE_URL to override the base URL. Every method rejects before sending a request if no key is set.

Events

Event	Required scope	Fires when
`api_mail_log_delivered`	`email_api`	An Email API message is delivered
`api_mail_log_opened`	`email_api`	A delivered message is opened
`api_mail_log_temporary_failure`	`email_api`	Delivery fails temporarily
`api_mail_log_permanent_failure`	`email_api`	Delivery fails permanently
`email.inbound.received`	`email_api`, with no sender-domain limit	Inbound mail is received
`forms.submission.created`	`forms`	A form submission is received

The SDK doesn’t check event names. The API returns 422 for an unknown event and 403 for an event the key isn’t scoped for. Email API keys created in the Paubox Dashboard are limited to a sender domain, so subscribe to inbound mail in the Paubox Dashboard under Settings > Webhooks. For payloads and signature verification, see Webhooks.

List webhook endpoints

const result = await webhooks.listWebhookEndpoints({ page: 1, items: 50 });

for (const endpoint of result.data) {
  console.log(endpoint.id, endpoint.target_url, endpoint.status);
}
console.log(result.page_info.count);

The argument is optional. The result is { data, page_info }; page_info.count is the total number of endpoints, not the length of this page. Endpoints carrying an event the key isn’t scoped for are left out.

Create a webhook endpoint

const endpoint = await webhooks.createWebhookEndpoint({
  target_url: 'https://example.com/webhooks/paubox',
  events: ['api_mail_log_delivered', 'api_mail_log_opened'],
});

console.log(endpoint.id);
console.log(endpoint.signing_secret);

target_url must be an https URL that doesn’t point at a private or internal address. Each endpoint has id (a UUID), target_url, status (active or disabled), events, created_at, and updated_at. signing_secret is returned only by this call; store it when you create the endpoint. To replace a lost secret, delete the endpoint and create a new one.

Get a webhook endpoint

const endpoint = await webhooks.getWebhookEndpoint('2ec66c21-bf48-48eb-8d28-f80b2d6b77c7');

Update a webhook endpoint

const endpoint = await webhooks.updateWebhookEndpoint('2ec66c21-bf48-48eb-8d28-f80b2d6b77c7', {
  status: 'disabled',
});

Pass any of target_url, status (active or disabled), and events. Only the fields you pass are sent. events replaces the endpoint’s event list.

Delete a webhook endpoint

await webhooks.deleteWebhookEndpoint('2ec66c21-bf48-48eb-8d28-f80b2d6b77c7');

The Promise resolves to undefined.

Error handling

try {
  await webhooks.createWebhookEndpoint({
    target_url: 'https://example.com/webhooks/paubox',
    events: ['api_mail_log_delivered'],
  });
} catch (err) {
  console.error(err.status, err.message);
}

A non-2xx response rejects with an Error whose message is the API’s error text and whose status is the HTTP status. Creating a second endpoint for the same target_url returns 422, and an ID that isn’t on your account returns 404. An ID that isn’t a UUID rejects before any request is sent.

Get started

Email API

Migrate to Paubox

Marketing API

MCP Server

SDKs

CLI

Forms API

Create the service

Events

List webhook endpoints

Create a webhook endpoint

Get a webhook endpoint

Update a webhook endpoint

Delete a webhook endpoint

Error handling

​Create the service

​Events

​List webhook endpoints

​Create a webhook endpoint

​Get a webhook endpoint

​Update a webhook endpoint

​Delete a webhook endpoint

​Error handling

Create the service

Events

List webhook endpoints

Create a webhook endpoint

Get a webhook endpoint

Update a webhook endpoint

Delete a webhook endpoint

Error handling