Skip to main content
PATCH
Core - Update notifier

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

notifier_id
string
required

Body

application/json

Partial notifier update. All request body fields are optional individually, but at least one field must be provided. When changing type, include the destination field required by the new type. 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.

project_id
string

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_name
string

Optional. New human-readable notifier name.

metadata
object

Optional. Replacement custom JSON metadata.

type
enum<string>

Optional. New destination type. When provided, also provide the destination field required by the new type.

Available options:
NOTIFIER_TYPE_UNSPECIFIED,
NOTIFIER_TYPE_EMAIL,
NOTIFIER_TYPE_SLACK_WEBHOOK,
NOTIFIER_TYPE_WEBHOOK
emails
string[]

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

incoming_webhook_url
string

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

webhook_url
string

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

headers
object

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

200 - application/json

OK

notifier
Email notifier · object
required

Notifier resource. The destination field present on the resource depends on type and is captured in oneOf.