Skip to main content
POST
Lookup Alerts

Overview

Polling pattern: when your webhook handler skips a delivery (endpoint offline, crash, hand-off between workers), persist the alert IDs you’ve seen and reconcile by calling this endpoint to confirm end-to-end delivery. Malformed IDs, or IDs of the wrong type, fail the whole request with 400, with each offending entry called out by index (ids[3]). IDs that are well-formed but unknown, including IDs belonging to another org, are silently dropped from the result rather than erroring, so any gap between what you sent and what came back is real. GET /v1/alerts/{id} for a single unknown or foreign ID still returns 404. Requires the portfolios:manage scope.
Lookup is a read-shaped operation, so the Idempotency-Key header is not required. Sending one, as in the example below, is always safe.

Body Parameters

string[]
required
1-100 alert IDs (alt_*).

Response

string
Always "list".
object[]
Array of Alert objects (see List Alerts for the shape). Order isn’t guaranteed to match ids.
string
Request identifier.

Errors

Code Examples