Skip to main content
POST
/
v1
/
notifications
/
custom
Create Custom Notification Rule
curl --request POST \
  --url https://app.nex.ai/api/developers/v1/notifications/custom \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "prompt": "<string>",
  "is_enabled": true,
  "schedule": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

API key for authentication (format: "Bearer YOUR_API_KEY")

Body

application/json

Custom notification rule to create

description
string
required

Natural language description of what you want to be notified about

Response

Created custom notification rule

id
string

Unique rule ID

name
string

Human-readable rule name

prompt
string

The natural language prompt describing the notification condition

is_enabled
boolean

Whether the rule is currently active

schedule
string

Cron-style schedule for rule evaluation

created_at
string<date-time>

When the rule was created

Last modified on March 24, 2026