POST /v1/create-alert

curl --request POST \
  --url https://api.getbluejay.ai/v1/create-alert

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getbluejay.ai/v1/create-alert",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getbluejay.ai/v1/create-alert"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.getbluejay.ai/v1/create-alert")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

Creates an alert. source_scope selects the data: observability, simulation, or all.

For observability, threshold_time_interval is a window in seconds. The default is 600. min_events defaults to 10.
For simulation, threshold_time_interval is the number of recent completed runs. The default is 1. min_events is not used.
sample_size evaluates the last N conversations instead of a time window. The minimum is 30. The alert does not fire with fewer than N conversations.

Each entry in notification_channels has a type and a target. The target depends on the type:

email: the email address
slack: the Slack channel ID
webhook: the webhook URL
pagerduty: the PagerDuty routing key
betterstack: Bluejay ignores target and uses the connected API token

To connect each channel, see Alerts.

Headers

Request body

Response

Status codes

Status	Meaning
`200`	Successful Response
`422`	Validation Error

Example request

curl --request POST \
  --url https://api.getbluejay.ai/v1/create-alert \
  --header 'X-API-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "sample_size": 123,
    "name": "<string>",
    "description": "<string>",
    "is_enabled": true,
    "entity_type": "standard_metric",
    "entity_field": "<string>",
    "operator": "equals",
    "comparison_value": "<string>",
    "notification_channels": [
      {
        "type": "<string>",
        "target": "<string>"
      }
    ],
    "applies_to_all_agents": true,
    "agent_ids": [
      123
    ],
    "simulation_id": 123,
    "evaluation_scope": "per_test_result",
    "aggregation": "none",
    "threshold_time_interval": 123,
    "min_events": 123,
    "min_events_type": "events",
    "source_scope": "all"
  }'

Example response

200

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "is_enabled": true,
  "organization_id": "<string>",
  "entity_type": "standard_metric",
  "entity_field": "<string>",
  "operator": "equals",
  "comparison_value": "<string>",
  "notification_channels": [
    null
  ],
  "last_triggered_at": "2026-01-01T00:00:00Z",
  "trigger_count": 123,
  "created_by": "<string>",
  "applies_to_all_agents": true,
  "agents": [
    123
  ],
  "simulation_id": 123,
  "evaluation_scope": "<string>",
  "aggregation": "<string>",
  "created_at": "2026-01-01T00:00:00Z",
  "updated_at": "2026-01-01T00:00:00Z",
  "updated_by": "<string>",
  "threshold_time_interval": 123,
  "min_events": 123,
  "min_events_type": "events",
  "in_alert": true,
  "source_scope": "all",
  "simulation_name": "<string>",
  "sample_size": 123
}

Last modified on October 21, 2026

⌘I

POST /v1/create-alert

curl --request POST \
  --url https://api.getbluejay.ai/v1/create-alert

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getbluejay.ai/v1/create-alert",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getbluejay.ai/v1/create-alert"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.getbluejay.ai/v1/create-alert")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

Overview

Test

Monitor

Improve

Configure

POST /v1/create-alert

Headers

Request body

Response

Status codes

Example request

Example response

​Headers

​Request body

​Response

​Status codes

​Example request

​Example response

Headers

Request body

Response

Status codes

Example request

Example response