reports

Create an alert (two-step; the preview runs the source once on live data)

A connector tool + a closed condition + a timing + a send policy. The preview shows the current value and whether the engine would raise now; nothing is stored until confirm.

post/api/orgs/{orgId}/alerts

Request

  • Base URL: https://api.wizbi.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.wizbi.ai/api/orgs/{orgId}/alerts
  • Auth: none declared

Path parameters

orgIdstring required

Request body

titlestring required
severity'low' | 'medium' | 'high'
onceboolean
frequency'once' | 'dates' | 'every_minutes' | 'hourly' | 'daily' | 'weekly' | 'monthly' | 'custom' required
atstring

once: local "YYYY-MM-DDTHH:MM" in the caller's zone.

in_minutesinteger

once, instead of at: minutes from now.

every_minutesinteger

every_minutes: 15, 20, 30 or 45.

every_hoursinteger

hourly: every N hours (1,2,3,4,6,8,12).

minuteinteger

Minute past the hour, multiple of 5.

hourinteger

daily/weekly/monthly: hour of day 0-23.

weekdayinteger

weekly: 0 = Sunday … 6 = Saturday.

day_of_monthinteger

monthly: 1-31 (29-31 fall back to a short month's last day).

timesstring[]

custom: "HH:MM".

month_daysinteger[]
monthsinteger[]
nth_weekdaysstring[]

custom: "n:weekday" ("1:0" = first Sunday, "-1:5" = last Friday).

every_daysinteger

custom: every N days.

every_weeksinteger

custom: every N weeks.

anchor_datestring
datesstring[]
start_datestring nullable
end_datestring nullable
max_runsinteger

Stop after this many deliveries (0 clears).

skip_holidaysboolean
from_hourinteger

every_minutes/hourly: first hour of the window.

to_hourinteger

every_minutes/hourly: last hour of the window (inclusive).

daysinteger[]
timezonestring

IANA zone for this schedule.

destinationstring
born_fromstring
confirmboolean

false (default) = preview, nothing changes; true = act.

Response

Preview, or the created alert.

AlertAnswer required

Changes

No recorded changes to this operation across all 2 revisions of this API.