include=["matches"] to embed the most recent matches the alert has caught, and include=["deliveries"] for the email delivery audit log. For the full, paginated match history with transcript excerpts, use particle_alert_list_matches.
Inputs
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
alert_id | string | yes | — | Alert id from particle_alert_list or particle_alert_create. |
include | array of enums | no | [] | Optional sections to embed: matches (the most recent matches the alert has caught), deliveries (the email delivery audit log). |
match_limit | integer (1–25) | no | 5 | How many recent matches to embed when include=["matches"]. Use particle_alert_list_matches for full pagination and transcript windows. |
Output
A markdown document with the alert configuration (same shape asparticle_alert_create): the title as an H2, **ID:**, **Kind:**, **Delivery:**, **Status:** rows, an optional **Description:** row, a ### Watching (N) entity list, and a **Notify:** row.
When requested, a ### Recent matches (N) section embeds each match as a bullet naming the episode and mention count (with the episode slug), and a ### Recent deliveries (N) section lists each delivery as \id` · channel · status · N matches`.
Sample (alert_id="dKxN6Ry2mL9pJ5qW", include=["matches"]):
output_format: "json" returns the same fields (plus matches/deliveries) as compact JSON.
Example
Related
- REST equivalent:
GET /v1/alerts/{id}. - For the full, paginated match history with transcript windows, use
particle_alert_list_matches. - Update or pause the alert with
particle_alert_update; remove it withparticle_alert_delete.