ORorq-ai
Notifiers

Update a notifier

Changed on

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

patch/v2/notifiers/{notifier_id}

Request

  • Base URL
    https://my.orq.ai
  • URL
    https://my.orq.ai/v2/notifiers/{notifier_id}
  • Auth
    HTTP bearer

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_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.

Example request

{
  "type": "NOTIFIER_TYPE_SLACK_WEBHOOK"
}

Response

OK

Example response

{
  "notifier": {
    "type": "NOTIFIER_TYPE_SLACK_WEBHOOK"
  }
}

Changes

  • 0b4e519a544fRevision changes
    • breaking

      removed the enum value NOTIFIER_TYPE_UNSPECIFIED of the request property

    • info

      added the non-success response with the status

    • info

      removed the NOTIFIER_TYPE_UNSPECIFIED enum value from the / response property for the response status

  • 732aed62833aRevision changes
    • warning

      added the new NOTIFIER_TYPE_UNSPECIFIED enum value to the / response property for the response status

    • info

      added the new NOTIFIER_TYPE_UNSPECIFIED enum value to the request property

    • info

      removed the non-success response with the status