Version
GET

List your alert destinations

/v1/me/alert-destinations in the Alert Destinations API.

Your destinations, primary first.

  • kind is connector_identity or email (push_device is reserved for the creator apps).
  • target is the connector account's id for connector_identity, the same value GET /v1/me/identities returns as the account behind a linked identity, or the email address for email.
  • classes lists the alert classes routed here, is null for every class, or is [] for none (the account is kept but receives nothing).
  • is_primary marks the destination of your primary connected account. It is derived from your linked identities, never set through this API.

Until you write a destination, you are on the default: every class of alert goes to your primary connected account, and the critical classes go to your email as well. The list is empty while the default applies, and the dashboard grid shows the default as every cell ticked on that account. Linking a primary account writes the default down as rows and adds the new account to them, so from then on the rows lead.

Critical classes always reach your email. Recovery, billing and security alerts are sent to your email whatever the destinations say, because they arrive when the connector you would otherwise read them on may have just failed. Routing them to a connected account adds a message there; it never removes the email.

GET
/v1/me/alert-destinations

Requires ability

The token must hold this ability, or the call is refused with 403.

MCP tool

Runs the same action from an agent, behind the same ability.

Authorization

bearerToken
AuthorizationBearer <token>

A personal access token minted on the dashboard under Settings, then Tokens, sent as Authorization: Bearer sbt_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team.

In: header

Responses

200OK

Array of AlertDestinationResource

401Unauthorized

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

403Forbidden

The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description.

429Too many requests

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

How is this guide?

Last updated on