Skip to content

Update a notification destination

PATCH /notification-destination/{id}

`config` is shallow-MERGED over the stored config. **`webhook_url`, when present, REPLACES the stored secret entirely.** `type` cannot be changed. Requires `notification:manage`.

Path Parameters

idstring
required·

Notification destination id (onfd_…).

Request Body

configobject

Non-secret settings. to/cc/bcc apply to email; ignored for slack.

bccstring[]
ccstring[]
subject_prefixstring
tostring[]
event_typesstring[]
Possible values:
connection.needs_reauthconnection.disconnectedmember.joinedmember.removedmember.roles_updatedinvite.sentinvite.revokedrole.createdrole.updatedrole.deletedrestriction.updatedconnector.created+ 8 more
is_activeboolean
namestring
webhook_urlstring,null

Response Body

configobject

Non-secret settings. to/cc/bcc apply to email; ignored for slack.

bccstring[]
ccstring[]
subject_prefixstring
tostring[]
created_atstring · date-time
created_by_user_idstring,null
event_typesstring[]

Fixed catalog of org events this destination is subscribed to.

Possible values:
connection.needs_reauthconnection.disconnectedmember.joinedmember.removedmember.roles_updatedinvite.sentinvite.revokedrole.createdrole.updatedrole.deletedrestriction.updatedconnector.created+ 8 more
idstring

Notification destination id (onfd_…).

is_activeboolean

Paused destinations keep their config but forward nothing.

last_test_atstring,null · date-time
last_test_statusstring,null
Possible values:
okfailednull
namestring
typestring

Immutable after creation.

Possible values:
slackemail
updated_atstring · date-time
curl -X PATCH 'https://api.elaichi.ai/notification-destination/<id>' \
  -H 'Authorization: Bearer $ELAICHI_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name":"your_name","is_active":true,"config":{},"event_types":[]}'
const body = {
  "name": "your_name",
  "is_active": true,
  "config": {},
  "event_types": []
};

const response = await fetch('https://api.elaichi.ai/notification-destination/<id>', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer ' + process.env.ELAICHI_API_TOKEN,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);
import os
import requests

url = "https://api.elaichi.ai/notification-destination/<id>"
headers = {
    "Authorization": f"Bearer {os.environ['ELAICHI_API_TOKEN']}",
    "Content-Type": "application/json",
}
payload = {
    "name": "your_name",
    "is_active": True,
    "config": {},
    "event_types": []
}

response = requests.patch(url, headers=headers, json=payload)
print(response.json())