Create notification rule | Sarvam API Docs

import requests
url = "https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id/notifications"
payload = {
    "widget_id": "a4c9e0f7-31b8-4d6a-9e25-7f0b3c81d46e",
    "cron": "30 3 * * *",
    "name": "Daily connectivity to ops",
    "email_recipients": ["ops@example.com"],
    "slack_webhook_url": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX",
    "slack_channel_name": "#agent-ops"
}
headers = {
    "X-API-Key": "<your-api-key>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "rule_id": "9e3f61d0-4a28-4c75-b13e-6d8025af7c94",
  "widget_id": "a4c9e0f7-31b8-4d6a-9e25-7f0b3c81d46e",
  "cron": "30 3 * * *",
  "enabled": true,
  "created_at": "2026-09-05T07:40:12Z",
  "updated_at": "2026-09-05T07:40:12Z",
  "name": "Daily connectivity to ops",
  "next_run_at": "2026-09-16T22:00:00Z",
  "email_recipients": [
    "ops@example.com"
  ],
  "slack_channel_name": "#agent-ops",
  "slack_configured": true
}

Creates a rule that runs widget_id on a cron schedule and delivers the result by email, Slack, or both. widget_id must name a widget on this board.

Path parameters

org_idstringRequired

Organization ID

workspace_idstringRequired

Workspace ID

board_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

widget_idstringRequiredformat: "uuid"

Widget whose result is delivered on this schedule

cronstringRequired>=1 character

Five-field cron expression evaluated in Asia/Kolkata. The minimum interval is one hour.

namestring or nullOptional1-80 characters

Label for the rule

email_recipientslist of strings or nullOptional

Email addresses to deliver to. At least one of this or slack_webhook_url is required.

slack_webhook_urlstring or nullOptional

Slack incoming-webhook URL. Write-only: never returned by any endpoint.

slack_channel_namestring or nullOptional<=80 characters

Display label for the Slack destination

Response

Successful Response

rule_idstringformat: "uuid"

Rule identifier, used as {rule_id} in nested routes

widget_idstringformat: "uuid"

Widget whose result this rule delivers

cronstring

Five-field cron expression, evaluated in Asia/Kolkata

enabledboolean

False while the schedule is paused

created_atdatetime

Creation time, UTC, RFC 3339

updated_atdatetime

Last change time, UTC, RFC 3339

namestring or nullOptional

Label for the rule, or null when unnamed

next_run_atdatetime or nullOptional

Next scheduled delivery, UTC. Null when the rule is disabled.

email_recipientslist of strings or nullOptional

Configured email recipients

slack_channel_namestring or nullOptional

Slack destination label, when one is configured

slack_configuredbooleanOptionalDefaults to false

True when a Slack webhook is set. The URL itself is never returned.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

Path parameters

Headers

Request

Response

Errors