account API — Beaam reference
40 of Beaam's 119 capabilities: Profile, organizations, notification channels, API keys, and billing. Generated from the live capability manifest.
accept-invitation#
Accept an invitation — Accept an organization invitation using its token. Joins the org and makes it your active organization.
auth required
| Field | Type | Required | Description |
|---|---|---|---|
token | string | yes | The invitation token from the accept link. |
acknowledge-welcome#
Acknowledge the welcome — Record that this account has seen its welcome message, so it is shown once and never again.
auth requiredmcp
Takes no input.
cancel-maintenance-window#
Cancel a maintenance window — Remove a planned quiet period so alerts resume. Cancelling an active window restores alerting immediately.
auth requiredmcp
| Field | Type | Required | Description |
|---|---|---|---|
windowId | string | yes | The window to cancel. |
cancel-subscription#
Cancel subscription — Cancel the caller's Solo subscription at the end of the current billing period (downgrade to Free). Access continues until period end.
auth requireddestructive
Takes no input.
create-api-key#
Create an API key — Create a personal API key for the public API and the hosted MCP server. The secret is shown once at creation.
auth required
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | A label to recognise this key, e.g. 'Claude MCP'. |
expiresInDays | integer | no | Days until the key expires. Omit or 0 for a key that never expires. |
create-checkout#
Start Solo checkout — Create a secure Polar checkout session for the signed-in Beaam account's $19/month Solo plan.
auth required
| Field | Type | Required | Description |
|---|---|---|---|
entryPoint | string | no | Optional label for where the upgrade was started (e.g. integrations_hub, sidebar_meter). |
create-organization#
Create an organization — Create a new organization (a separate workspace with its own integrations, members, and plan) and switch to it.
auth required
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | A name for the new organization. |
delete-account#
Delete account — Permanently delete your Beaam account and associated monitoring data after password reauthentication. Irreversible.
auth requireddestructive
| Field | Type | Required | Description |
|---|---|---|---|
password | string | yes | Current password, used for recent reauthentication. |
confirm | string | yes | Must equal "DELETE MY ACCOUNT". |
delete-all-data#
Delete all integrations and data — Remove every integration and all monitoring data (services, history, incidents, alerts, credentials). Notification channels are kept. Pass confirm:"DELETE". Irreversible.
auth requireddestructive
| Field | Type | Required | Description |
|---|---|---|---|
confirm | string | yes | Must equal "DELETE" to proceed. Guards against accidental wipes. |
delete-notification-channel#
Delete notification channel — Delete one of the user's notification channels by id.
auth requireddestructivemcp
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | Channel id to delete. |
delete-organization#
Delete an organization — Permanently delete an organization and all of its data (integrations, services, history, members). Owner only.
auth requireddestructive
| Field | Type | Required | Description |
|---|---|---|---|
confirmName | string | yes | The organization's exact name, to confirm deletion. |
orgId | string | no | Organization to delete. Defaults to your active organization. |
get-activation-progress#
Get activation progress — Show whether this account has connected monitoring, received its first real signal, and verified its default alert path.
auth requiredread-onlymcp
Takes no input.
get-billing#
Get billing & plan — Return the active organization's effective plan and usage, plus the caller's own account plan and available billing actions.
auth requiredread-only
Takes no input.
get-webhook-signing-secret#
Get webhook signing secret — Return the Standard Webhooks signing secret for one of your webhook notification channels, so your endpoint can verify that a request really came from Beaam.
auth requiredread-only
| Field | Type | Required | Description |
|---|---|---|---|
channelId | string | yes | Id of the webhook notification channel. |
invite-member#
Invite a member — Invite someone to your active organization by email and get a one-time link to share. Owners and admins only.
auth required
| Field | Type | Required | Description |
|---|---|---|---|
email | string | yes | Email address of the person to invite. |
role | string | no | Role to grant. Defaults to member. |
join-waitlist#
Join the waitlist — Add an email address to the Beaam waitlist.
public
| Field | Type | Required | Description |
|---|---|---|---|
email | string | yes | Email to add to the waitlist. |
source | string | null | no | Where they signed up. |
list-api-keys#
List API keys — Return the caller's API keys — name, prefix, created and last-used times, and whether revoked. Never returns the secret.
auth requiredread-only
Takes no input.
list-devices#
List mobile devices — Return the user's mobile devices registered for push alerts — platform, device name, and when each was last seen. Use unregister-device to remove one.
auth requiredread-onlymcp
Takes no input.
list-maintenance-windows#
List maintenance windows — Show the planned periods when alerts are withheld, and which of them is silencing you right now.
auth requiredread-onlymcp
| Field | Type | Required | Description |
|---|---|---|---|
includePast | boolean | no | Include windows that have already closed. Defaults to false. |
list-members#
List organization members — List the members of your active organization (with roles), plus pending invitations if you can manage members.
auth requiredread-only
Takes no input.
list-notification-channels#
List notification channels — Return the user's configured notification channels (email/SMS/push/Slack/webhook), each with its destination, enabled state, why Beaam disabled it if it did, and whether it's in the global default set. Pass serviceId to also get that service's routing.
auth requiredread-onlymcp
| Field | Type | Required | Description |
|---|---|---|---|
serviceId | string | no | If set, also return this service's routing (global default vs custom channel set). |
list-organizations#
List organizations — List the organizations you belong to, your role in each, and which one is currently active.
auth requiredread-only
Takes no input.
list-payments#
List payments — Return past payments for the signed-in account, newest first, with amount, status and a receipt link where one exists.
auth requiredread-only
Takes no input.
preview-invitation#
Preview an invitation — Look up an organization invitation by token to see the organization, invited email, and role.
publicread-only
| Field | Type | Required | Description |
|---|---|---|---|
token | string | yes | The invitation token from the accept link. |
record-product-event#
Record a product journey event — Record a non-sensitive setup, integration-selection, or upgrade-intent event for the signed-in account.
auth required
| Field | Type | Required | Description |
|---|---|---|---|
event | string | yes | A user-intent funnel event. Outcome milestones are recorded by Beaam itself. |
properties | object | no | Optional non-sensitive context such as provider or entry_point. |
register-device#
Register mobile device — Enroll a mobile device for push alerts using its Expo push token. Creates the push notification channel on first registration; re-registering the same token just refreshes it. A confirmed replaceExisting request moves the physical device from a previous account.
auth requiredmcp
| Field | Type | Required | Description |
|---|---|---|---|
expoPushToken | string | yes | The device's Expo push token, e.g. ExponentPushToken[xxxx]. |
platform | string | yes | |
deviceName | string | no | Human label for the device, e.g. "Nick's iPhone". |
replaceExisting | boolean | no | After explicit confirmation, move this physical device from a previous Beaam account to the current account. |
remove-member#
Remove a member — Remove a member from your active organization, revoking their access. Owners and admins only.
auth requireddestructive
| Field | Type | Required | Description |
|---|---|---|---|
userId | string | yes | The user id of the member to remove. |
rename-organization#
Rename an organization — Rename an organization (defaults to your active one). Owners and admins only.
auth required
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | The new organization name. |
orgId | string | no | Organization to rename. Defaults to your active organization. |
resume-subscription#
Resume subscription — Undo a scheduled cancellation so the caller's Solo subscription renews as normal instead of ending at the current period.
auth required
Takes no input.
revoke-api-key#
Revoke an API key — Revoke a personal API key by id; it stops working immediately.
auth requireddestructive
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | The API key id to revoke. |
revoke-assistant-connection#
Disconnect an AI assistant — End one AI client's access to this Beaam account. Its live tokens are revoked and any pending authorization is discarded, so it stops working immediately. Other connected clients are unaffected; reconnecting means authorizing again.
auth requireddestructive
| Field | Type | Required | Description |
|---|---|---|---|
clientId | string | yes | Client id of the connection to revoke, from list-assistant-connections. |
revoke-invitation#
Revoke an invitation — Revoke a pending invitation to your active organization, invalidating its link. Owners and admins only.
auth required
| Field | Type | Required | Description |
|---|---|---|---|
inviteId | string | yes | The id of the pending invitation to revoke. |
rotate-webhook-signing-secret#
Rotate webhook signing secret — Issue a new Standard Webhooks signing secret for one of your webhook notification channels. The change takes effect immediately and the previous secret stops working, so update your endpoint at the same time.
auth requireddestructive
| Field | Type | Required | Description |
|---|---|---|---|
channelId | string | yes | Id of the webhook notification channel. |
save-notification-channel#
Save notification channel — Create or update a notification channel. type is email, sms, push, slack, or webhook; destination is an email address, E.164 phone, or https:// webhook URL. SMS channels require the Solo plan. Push channels can only be updated here — they're created by registering a device.
auth requireddestructivemcp
| Field | Type | Required | Description |
|---|---|---|---|
id | string | no | Existing channel id to update; omit to create. |
type | string | yes | |
label | string | yes | Human label, e.g. 'On-call SMS'. |
destination | string | yes | Email address, E.164 phone number, or https:// webhook URL (slack = a Slack incoming webhook; webhook = any endpoint that accepts a JSON POST). Ignored for push (delivery goes to registered devices). |
enabled | boolean | no | Whether this channel can fire. |
isDefault | boolean | no | Include in the global default routing set used by services with no override. |
smsConsent | boolean | no | Required for SMS channels: confirms the person holding this number agreed to receive Beaam Alerts texts, having been shown the program name, that frequency varies, that message and data rates may apply, and how to stop. Needed when creating an SMS channel, re-enabling a disabled one, or changing its number. Must reflect a real affirmative act by that person — not a default. |
schedule-maintenance-window#
Schedule a maintenance window — Plan a period when Beaam should not page you — a deploy or migration. Incidents are still detected and recorded; only the alert is withheld, with your reason attached. Never silences the checks that tell you Beaam itself stopped watching.
auth requireddestructivemcp
| Field | Type | Required | Description |
|---|---|---|---|
startsAt | string | yes | When the window opens (ISO 8601). |
endsAt | string | yes | When it closes (ISO 8601). Required — silence is always bounded. |
reason | string | yes | Why, in a few words. Shown on the withheld alert. |
scope | string | no | Everything, one stack, or one service. Defaults to service when a serviceId is given. |
stackId | string | null | no | Required for scope 'stack'. |
serviceId | string | null | no | Required for scope 'service'. |
send-test-alert#
Send a test alert — Send a harmless test alert through your real notification channels (email, SMS, push, Slack, or webhook) and report whether each delivery worked. Omit channelId to test all enabled default channels.
auth requiredmcp
| Field | Type | Required | Description |
|---|---|---|---|
channelId | string | no | Test a single channel by id. Omit to test every enabled default channel. |
set-ai-explanations#
Set AI incident explanations — Turn AI incident explanations on or off for your organization. When on, Beaam may send a short incident evidence summary to an LLM to write a one-sentence explanation; when off, no incident data is ever sent to an LLM.
auth required
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | yes | Turn AI incident explanations on or off for the organization. |
orgId | string | no | Organization to change. Defaults to your active organization. |
set-service-notifications#
Set service notifications — Choose how a service's alerts route: 'global' uses the default channels; 'custom' uses the given channelIds. Pass the service id and mode.
auth requireddestructivemcp
| Field | Type | Required | Description |
|---|---|---|---|
serviceId | string | yes | |
mode | string | yes | global = use the default channel set; custom = use channelIds. |
channelIds | array | no | Channel ids to route to when mode is custom. |
switch-organization#
Switch active organization — Make one of your organizations the active one for the current session. You must be a member of it.
auth required
| Field | Type | Required | Description |
|---|---|---|---|
orgId | string | yes | The organization to make active. |
unregister-device#
Unregister mobile device — Remove a mobile device from push alerting, by device id or by its Expo push token. Removing the last device also removes the push notification channel; registering again restores it.
auth requireddestructivemcp
| Field | Type | Required | Description |
|---|---|---|---|
deviceId | string | no | Device id from list-devices. |
expoPushToken | string | no | Alternatively, the device's own Expo push token. |
Badges. read-only makes no changes ·destructive changes or removes something you already have ·mcp is exposed to assistants through the MCP connector ·public needs no authentication. Calling conventions and the response envelope are on the reference index.
Other categories: status (26), integrations (41), history (12).
Back to the API reference