Skip to main content
PUT
/
webhooks
/
{id}
TypeScript
import Nuntly from '@nuntly/sdk';

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

const webhook = await client.webhooks.update('wh_YNtYn86oYZmP1ZHbnUBvXXFt');

console.log(webhook.id);
{
  "data": {
    "id": "wh_01jne5c7gr2mhwrqg4zqwf48y2",
    "org_id": "org_01jh6jk82zjq9deye73h0mzcaq",
    "kind": "webhook"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The webhook id previously created

Body

application/json
​
name
string

The name of the webhook

​
endpoint_url
string<uri>

The endpoint URL of the webhook

​
events
enum<string>[]
Minimum array length: 1

The webhook events

Available options:
email.sent,
email.delivered,
email.opened,
email.clicked,
email.bounced,
email.complained,
email.rejected,
email.delivery_delayed,
email.failed
​
status
enum<string>

The status of the webhook.

Available options:
enabled,
disabled
​
rotate_secret
boolean

If true, a new signing secret will be generated

Response

A successful response

​
data
object
Example:
{
  "id": "wh_01jne5c7gr2mhwrqg4zqwf48y2",
  "org_id": "org_01jh6jk82zjq9deye73h0mzcaq",
  "kind": "webhook"
}