Sign in

v171

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0726249111.7 MB
Notifiers

Update a notifier

Partially updates an existing notifier. When changing type, provide the destination fields required by the new notifier type.

patch/v2/notifiers/{notifier_id}

Path parameters

notifier_idstring required

Request body

project_idstring

Optional. New containing project. Workspace-scoped callers may set an empty value to make the notifier workspace-wide. Project-scoped API keys remain pinned to the API key's project.

display_namestring

Optional. New human-readable notifier name.

metadataobject

Optional. Replacement custom JSON metadata.

type'NOTIFIER_TYPE_UNSPECIFIED' | 'NOTIFIER_TYPE_EMAIL' | 'NOTIFIER_TYPE_SLACK_WEBHOOK' | 'NOTIFIER_TYPE_WEBHOOK'
emailsstring[]

Optional replacement email recipients. Required when changing type to NOTIFIER_TYPE_EMAIL.

incoming_webhook_urlstring

Optional replacement Slack incoming webhook URL. Required when changing type to NOTIFIER_TYPE_SLACK_WEBHOOK.

webhook_urlstring

Optional replacement generic webhook URL. Required when changing type to NOTIFIER_TYPE_WEBHOOK.

headersobject

Optional replacement generic webhook headers. Secret header values returned by GET or LIST are masked as an empty string; omit those entries or replace them with the real value when updating.

Response

OK