Skip to main content
PATCH
Change a notification rule

Authorizations

Authorization
string
header
required

A workspace API key issued in Settings → Developer, sent as Bearer sk_….

Path Parameters

category
enum<string>
required

The event category the rule covers.

Available options:
action_required,
error,
status_update,
insight,
completion
Example:

"action_required"

Body

application/json
channels
enum<string>[]

Replaces the list. At least one channel.

Minimum array length: 1
Available options:
chat,
email,
slack,
discord,
telegram,
imessage,
custom_webhook
Example:
isActive
boolean

Response

The updated rule.

id
string
required
eventCategory
enum<string>
required

action_required (needs input), error, status_update, insight, completion. GEO notification types map one to one: geo_action_required, geo_error, geo_status_update, geo_insight, geo_completion.

Available options:
action_required,
error,
status_update,
insight,
completion
channels
string[]
required

Where this category goes: chat, email, slack, discord, telegram, imessage, custom_webhook. custom_webhook sends to every enabled webhook in GET /v1/webhooks.

isActive
boolean
required

False: this category does not notify at all.

batchingEnabled
boolean
required
batchWindowMinutes
integer
required
quietHoursStart
string | null
required

HH:MM, in quietHoursTimezone.

quietHoursEnd
string | null
required
quietHoursTimezone
string | null
required