Notifiers for alert destinations

Use Cases

Sending threshold alerts to an on-call address.
Posting a budget threshold into a Slack channel.
Forwarding alert payloads into an incident tool through a generic webhook.

Overview

A Notifier is a reusable destination that Alerts deliver to. One Notifier carries one channel and any number of Alerts can select it, so a destination is configured once and shared. Three channels are available: Email, Slack through an incoming webhook, and a generic Webhook.

Channels

Channel	`type`	Destination field	Notes
Email	`NOTIFIER_TYPE_EMAIL`	`emails`	One or more addresses. Duplicates and surrounding whitespace are removed, and each address is validated.
Slack	`NOTIFIER_TYPE_SLACK_WEBHOOK`	`incoming_webhook_url`	A Slack incoming webhook URL.
Webhook	`NOTIFIER_TYPE_WEBHOOK`	`webhook_url`	Any absolute HTTPS URL, with optional request headers.

Both webhook URLs must be absolute HTTPS URLs. A plain http:// URL is rejected with the offending field named, either webhook_url must be an absolute HTTPS URL or incoming_webhook_url must be an absolute HTTPS URL.

Create a notifier

AI Studio
API & SDK
CLI

Open Settings > Notifiers and select Notifier to open the sheet. A new one can also be created from the Alert form without leaving it.

Name the notifier

Enter a Name of up to 255 characters.

Choose a channel

Select Send via, then fill the destination the channel asks for: recipient addresses, a Slack incoming webhook URL, or a webhook URL with optional headers.

Save

Choose Create. The button stays disabled until the name and a valid destination are present.

curl -X POST https://my.orq.ai/v2/notifiers \
  -H "Authorization: Bearer $ORQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "display_name": "On-call email",
    "type": "NOTIFIER_TYPE_EMAIL",
    "emails": ["oncall@example.com"]
  }'

import { Orq } from "@orq-ai/node";

const orq = new Orq({ apiKey: process.env.ORQ_API_KEY });

const notifier = await orq.notifiers.create({
  displayName: "On-call email",
  type: "NOTIFIER_TYPE_EMAIL",
  emails: ["oncall@example.com"],
});

import os

from orq_ai_sdk import Orq

orq = Orq(api_key=os.environ["ORQ_API_KEY"])

notifier = orq.notifiers.create(
    request={
        "display_name": "On-call email",
        "type": "NOTIFIER_TYPE_EMAIL",
        "emails": ["oncall@example.com"],
    }
)

{
  "notifier": {
    "_id": "notifier_01m48465jqdz12asrmg7g7qcw7",
    "display_name": "On-call email",
    "type": "NOTIFIER_TYPE_EMAIL",
    "emails": ["oncall@example.com"],
    "project_id": "",
    "created_at": "2026-10-06T08:09:54.519Z"
  }
}

Parameters

Parameter	Type	Required	Description
`display_name`	string	Yes	Name shown wherever the notifier is selected. Up to 255 characters.
`type`	enum	Yes	`NOTIFIER_TYPE_EMAIL`, `NOTIFIER_TYPE_SLACK_WEBHOOK`, or `NOTIFIER_TYPE_WEBHOOK`.
`emails`	string array	For email	Recipient addresses. Required when the type is email.
`incoming_webhook_url`	string	For Slack	Absolute HTTPS URL. Required when the type is Slack.
`webhook_url`	string	For webhook	Absolute HTTPS URL. Required when the type is a generic webhook.
`headers`	object	No	Request headers for a generic webhook. See Secret headers.
`project_id`	string	No	Scope the notifier to one Project. Omitted means workspace-wide. A project-scoped API key always creates in its own project.
`metadata`	object	No	Custom JSON stored with the notifier.

The wire field is _id; the SDKs expose the same value as id.

orq notifiers create \
  --display-name "On-call email" \
  --type NOTIFIER_TYPE_EMAIL \
  --emails oncall@example.com

See the Orq CLI reference for installation and the flag conventions shared with the generated commands.

Manage notifiers

AI Studio
API & SDK
CLI

The Notifiers list shows each one with its Name, Destination, Type, and last update, and supports search by name, a type filter, and page sizes of 25, 50, or 100.

Notifiers table listing a Webhook and an Email notifier, each with a Name, Destination, Type, and Updated column. — Notifiers configured in the workspace, available for selection in an Alert.

Open the row menu to edit or delete one. A Notifier that an Alert or a budget alert still selects cannot be deleted: the API refuses with Notifier is in use and cannot be deleted. Remove it from those alerts first.

Operation	Endpoint
Create a notifier	`POST /v2/notifiers`
List notifiers	`GET /v2/notifiers`
Retrieve a notifier	`GET /v2/notifiers/{notifier_id}`
Update a notifier	`PATCH /v2/notifiers/{notifier_id}`
Delete a notifier	`DELETE /v2/notifiers/{notifier_id}`

GET /v2/notifiers accepts search for a case-insensitive match on the name, type to restrict the result to one or more channels, and project_id, and pages with starting_after and ending_before.

orq notifiers list
orq notifiers get <notifier_id>
orq notifiers update <notifier_id> --display-name "On-call"
orq notifiers delete <notifier_id>

Where notifiers are used

Surface	How the notifier is attached
Alerts	Selected under Notify via in the Alert form, which allows several and can create one inline. That page covers the cap and what happens to an Alert with none.
Budget alerts	On a budget threshold, where at least one Notifier is required.
Monitors	Create alert on a widget opens the Alerts form with the widget’s metric, so the same notifier selection applies.

Terraform

The provider manages notifiers with the orq_notifier resource, and notifier_ids attaches them to a budget alert or an alert rule. See Terraform quickstart and Importing resources.

Secret headers

A generic webhook can carry request headers. A header value is either a plain string or an object that marks it secret:

{
  "headers": {
    "Authorization": { "secret": true, "value": "Bearer sk-live-..." },
    "X-Source": "orq"
  }
}

A header marked {"secret": true} comes back empty on read and stays readable nowhere, unlike a plain header. For the full list of what each storage class protects, see Secrets.

Send notifications to a Microsoft Teams channel

Route alert notifications to a Microsoft Teams channel with a generic webhook Notifier. Teams renders messages in its own card format while Orq.ai sends a JSON envelope, so the webhook points at a small relay that converts the payload before forwarding it. The Microsoft Teams example covers the Teams workflow, the relay, and attaching the notifier to an alert.

Limitations

Limitation	Impact	Workaround
One channel per notifier	A destination that should receive both email and Slack needs two notifiers	Create one per channel and select both on the alert
No delivery log	The notifier record does not show what it sent	Check the receiving channel, or use a webhook endpoint that logs requests
Deletion is refused while in use	A notifier an Alert or budget alert still selects cannot be deleted	Remove it from those alerts, then delete it

Overview

Instrument your app

Explore

Monitor

Export

Review

Data privacy & security

Overview

Channels

Create a notifier

Manage notifiers

Where notifiers are used

Terraform

Secret headers

Send notifications to a Microsoft Teams channel

Limitations