Skip to main content
POST
Create Alert

Authorizations

x-maxim-api-key
string
header
required

API key for authentication

Body

application/json
workspaceId
string
required

Unique identifier for the workspace

entityId
string
required

ID of the entity to create alert for

type
enum<string>
required

Type of entity for the alert

Available options:
WORKFLOW,
WORKFLOW_SIMULATION,
PROMPT_CHAIN,
DATASET,
DATASET_SPLIT,
PROMPT,
DATASOURCE,
PROMPT_EXPERIMENT,
LOG_REPOSITORY,
PROMPT_TOOL,
EVALUATOR,
SDK,
TEST_RUN,
RUN_REPORT
config
object
required
enabled
boolean
default:true

Whether the alert is enabled

notificationChannelIds
string[]

List of notification channel IDs eg: ["channel_123", "channel_456"]

Response

Alert created successfully

id
string
required
workspaceId
string
required
entityId
string
required
type
string
required
enabled
boolean
required
config
object
required
createdAt
string
required
updatedAt
string
required
notificationChannels
object[]