00Widget

Whether anything will actually see what you publish, what this credential may do, how much rate budget is left, and what this deployment has enabled. Worth one call before publishing for the first time: if `delivery.canPushWidgets` is false, nothing you publish will be seen by anyone, and the operator needs to install the app and allow notifications rather than you trying again. `attention.liveActivities` names any activity of yours that has stopped telling the operator the truth; it is empty when there is nothing wrong.

get_status

Remove a published card. Widgets showing it stop showing it.

delete_card

End a running Live Activity with a final frame. Always end what you start. This cannot be undone: an ended activity cannot be resumed, only replaced by starting a new one, which the user sees as the old one dismissing and a new one animating in.

end_live_activity

Read one published card by its stable id. Returns `{ card }`, the same envelope every other read on this API uses.

get_card

The Live Activities this tenant currently has running, with their content state. Pass includeEnded to also get the ones that finished in the last day — which is how to check whether an end actually landed, or to find an activity whose externalActivityId you lost.

list_live_activities

List every dashboard card this credential's tenant has published, as stored. Use it to discover the ids already in use before publishing, and to read back what a widget shows.

list_cards

Create or replace one dashboard card, for standing state the operator checks on — a balance, a queue depth, today's total. For work with a start and an end that you will report on while it runs, start_live_activity is the better surface: it reaches the Lock Screen and Dynamic Island, where a card only reaches a Home Screen widget on a rationed refresh budget. The `id` is the identity of the thing being shown, so reuse it on every publish — never embed a timestamp or run id, or each update becomes a new card. Publishing several cards from one snapshot? Use upsert_cards_batch instead.

upsert_card

Create or replace up to 32 cards in one call. Always prefer this over repeated upsert_card when one snapshot produces several related cards: it makes a single widget-reload decision instead of burning WidgetKit's daily reload budget once per card. Set `replacePrefix` to your own id namespace and the snapshot also deletes what it no longer contains, which is the only way to stop reporting something without leaving a dead card behind.

upsert_cards_batch

Every published card and every running Live Activity in one call. Prefer it over list_cards plus list_live_activities when you want the whole picture — it is one request instead of two and the two halves are read together.

get_dashboard

The rules no argument schema can carry: which template fits which shape of data, what a Live Activity freezes at start, and what publishing etiquette costs you if you ignore it. Read it before publishing for the first time. ALWAYS pass `section`: pick `cards` or `live-activities` for the surface you decided on, which is half the size of the default and all of it relevant. Only fall back to `essentials` if you genuinely do not know yet which of the two you are publishing to.

get_integration_guide