import Nuntly from '@nuntly/sdk';
const client = new Nuntly({
apiKey: 'My API Key',
});
const webhook = await client.webhooks.create({
endpoint_url: 'https://webhook.site/12345678-1234-5678-1234-123456789012',
events: ['email.delivered', 'email.sent'],
status: 'enabled',
});
console.log(webhook.id);
{
"data": {
"id": "wh_01jne5c7gr2mhwrqg4zqwf48y2",
"org_id": "org_01jh6jk82zjq9deye73h0mzcaq",
"name": "My webhook",
"endpoint_url": "https://webhook.site/12345678-1234-5678-1234-123456789012",
"events": [
"email.delivered",
"email.sent"
],
"status": "enabled",
"signing_secret": "2VERerverv3V3RVeververv",
"created_at": "2025-03-03T14:08:22.552Z",
"modified_at": "2025-03-03T14:08:22.552Z",
"region": "eu-west-1",
"kind": "webhook"
}
}
Create a webhook so the endpoint is notified from Nuntly platform events (Emails events)
import Nuntly from '@nuntly/sdk';
const client = new Nuntly({
apiKey: 'My API Key',
});
const webhook = await client.webhooks.create({
endpoint_url: 'https://webhook.site/12345678-1234-5678-1234-123456789012',
events: ['email.delivered', 'email.sent'],
status: 'enabled',
});
console.log(webhook.id);
{
"data": {
"id": "wh_01jne5c7gr2mhwrqg4zqwf48y2",
"org_id": "org_01jh6jk82zjq9deye73h0mzcaq",
"name": "My webhook",
"endpoint_url": "https://webhook.site/12345678-1234-5678-1234-123456789012",
"events": [
"email.delivered",
"email.sent"
],
"status": "enabled",
"signing_secret": "2VERerverv3V3RVeververv",
"created_at": "2025-03-03T14:08:22.552Z",
"modified_at": "2025-03-03T14:08:22.552Z",
"region": "eu-west-1",
"kind": "webhook"
}
}
Bearer HTTP authentication. Allowed headers Authorization: Bearer <API_KEY>
A successful response
The response is of type object
.