---
title: "Alert Preview Route"
method: POST
path: "/api/schedule_defs/alert_preview"
---

# Alert Preview Route

`POST /api/schedule_defs/alert_preview`

## Request

- Base URL: `https://app.getdot.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://app.getdot.ai/api/schedule_defs/alert_preview`
- Auth: one of:
  - API key in header `X-API-KEY`
  - API key in cookie `Authorization`
  - OAuth 2 (password, token URL `/api/auth/token`)

Compile and try an alert condition against the app's current data —
the modal's honest confirm step (plain-words sentence, value now, replay).

## Request body

- AlertPreviewRequest
  - `app_id` string, required
  - `text` string, nullable
  - `trigger` object, nullable
  - `card` string, nullable
  - `every` string
  - `on` unknown
  - `schedule_id` string, nullable
  - `params` object, nullable

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/getdot/apis/dot-api-2.md) · [All operations](https://skmtc.dev/getdot/apis/dot-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/getdot/apis/dot-api-2/revisions/d26fe7163a7f?raw)