Notification destinations

Update a notification destination

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

patch/notification-destination/{id}

Request

  • Base URL: https://api.elaichi.ai
  • URL: https://api.elaichi.ai/notification-destination/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Notification destination id (onfd_…).

Headers

X-Organization-Idstring

Target organization (org_…). Required for cookie/session auth on org-scoped routes; optional for API tokens, which carry their organization, and rejected when it names a different one.

Request body

namestring
is_activeboolean
webhook_urlstring nullable
event_typesstring[]

Response

OK

idstring

Notification destination id (onfd_…).

type'slack' | 'email'

Immutable after creation.

namestring
is_activeboolean

Paused destinations keep their config but forward nothing.

event_typesstring[]

Fixed catalog of org events this destination is subscribed to.

last_test_atstring date-time nullable
last_test_status'ok' | 'failed' | 'null' nullable
created_by_user_idstring nullable
created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.