> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Better Stack

> How to set up the Better Stack connector, plus the actions and events that are available.

![Better Stack](https://stackone-logos.com/api/betterstack/filled/svg)

v2.0.0[See changelog](https://docs.stackone.com/connectors/betterstack/changelog.md)

[145 actions](#actions) · [10 events](#events) · 4 auth methods

Observability
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Global API Token · Connector Profile](https://docs.stackone.com/connectors/betterstack/guides/connector-profile/global-api-token.md)
>
> Works with every Better Stack product (Incidents, Telemetry, Errors) and every team. Needs the team name when the organi...

> [card] [Incidents API Token · Connector Profile](https://docs.stackone.com/connectors/betterstack/guides/connector-profile/incidents-api-token.md)
>
> Scoped to one team. Reaches monitors, heartbeats, incidents, on-call, status pages, team members and roles. Other produc...

> [card] [Telemetry API Token · Connector Profile](https://docs.stackone.com/connectors/betterstack/guides/connector-profile/telemetry-api-token.md)
>
> Scoped to one team. Reaches sources, dashboards, alerts and Errors applications and releases. Other products and the usa...

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/betterstack/guides/connector-profile/oauth-2-0.md)
>
> Acts as the signed-in Better Stack user, so comments and incidents are attributed to them. Requires registering a public...

Optionally, configure receiving Events for Better Stack into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/betterstack/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Global API Token · Link Account](https://docs.stackone.com/connectors/betterstack/guides/link-account/global-api-token.md)

> [card] [Incidents API Token · Link Account](https://docs.stackone.com/connectors/betterstack/guides/link-account/incidents-api-token.md)

> [card] [Telemetry API Token · Link Account](https://docs.stackone.com/connectors/betterstack/guides/link-account/telemetry-api-token.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/betterstack/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

Global API Token

Incidents API Token

OAuth 2.0

Telemetry API Token

No auth methods found

Scopes

Select all
|
Clear

read

write

No scopes found

145 actions

ActionDescriptionRequired scopes

Remove An Alert`betterstack_remove_alert`

Permanently delete an alert by ID, whether it is on a dashboard chart or an exploration.

`write`

Get A Single Alert`betterstack_get_alert`

Get one telemetry alert by ID.

`read`

List All Alerts`betterstack_list_alerts`

List all telemetry alerts across dashboards and explorations.

`read`

Update An Alert`betterstack_update_alert`

Update an alert by ID, whether it is on a dashboard chart or an exploration.

`write`

Create An Application`betterstack_create_application`

Creates a new error tracking application.

`write`

Remove An Application`betterstack_remove_application`

Deletes an existing error tracking application.

`write`

Get A Single Application`betterstack_get_application`

Get one error tracking application by ID.

`read`

List All Applications`betterstack_list_applications`

List error tracking applications.

`read`

Update An Application`betterstack_update_application`

Updates an existing error tracking application.

`write`

Create Catalog Attribute`betterstack_create_catalog_attribute`

Add an attribute (column) to a Catalog relation.

`write`

Create Catalog Record`betterstack_create_catalog_record`

Add a record to a Catalog relation, giving a value for each of its attributes.

`write`

Create Catalog Relation`betterstack_create_catalog_relation`

Create a Catalog relation, a custom inventory such as services or teams.

`write`

Remove Catalog Attribute`betterstack_remove_catalog_attribute`

Permanently deletes an existing Catalog attribute.

`write`

Remove Catalog Record`betterstack_remove_catalog_record`

Permanently deletes an existing Catalog record.

`write`

Remove Catalog Relation`betterstack_remove_catalog_relation`

Permanently deletes an existing Catalog relation.

`write`

List Catalog Attributes`betterstack_list_all_catalog_attributes`

List the attributes (columns) of a Catalog relation; create\_catalog\_record needs their IDs.

`read`

List Catalog Records`betterstack_list_all_catalog_records`

List the records of a Catalog relation.

`read`

List Catalog Relations`betterstack_list_all_catalog_relations`

List Catalog relations, the custom inventories (such as services or teams) defined in Better Stack.

`read`

Get Catalog Attribute`betterstack_get_catalog_attribute`

Get one attribute of a Catalog relation by ID.

`read`

Get A Single Catalog Record`betterstack_get_catalog_record`

Get one Catalog record by ID.

`read`

Get Catalog Relation`betterstack_get_catalog_relation`

Get one Catalog relation by ID, including its attributes.

`read`

Update Catalog Attribute`betterstack_update_catalog_attribute`

Update an existing Catalog attribute.

`write`

Update Catalog Record`betterstack_update_catalog_record`

Update an existing Catalog record.

`write`

Update Catalog Relation`betterstack_update_catalog_relation`

Update an existing Catalog relation.

`write`

Create A Dashboard Group`betterstack_create_dashboard_group`

Creates a new dashboard group for organizing dashboards.

`write`

Remove A Dashboard Group`betterstack_remove_dashboard_group`

Permanently deletes a dashboard group by its ID.

`write`

Get A Single Dashboard Group`betterstack_get_dashboard_group`

Retrieves a single dashboard group by its ID.

`read`

List All Dashboard Groups`betterstack_list_dashboard_groups`

Retrieves a paginated list of your team's dashboard groups.

`read`

Update A Dashboard Group`betterstack_update_dashboard_group`

Updates an existing dashboard group by its ID.

`write`

Create A Dashboard Alert`betterstack_create_dashboard_alert`

Creates a new alert for a specific dashboard chart.

`write`

Create A Dashboard`betterstack_create_dashboard`

Creates a new dashboard, including its variables and other properties.

`write`

Remove A Dashboard`betterstack_remove_dashboard`

Permanently deletes an existing dashboard.

`write`

Get A Single Dashboard`betterstack_get_dashboard`

Get one dashboard by ID, including its charts, sections and variables.

`read`

List All Dashboards`betterstack_list_dashboards`

List telemetry dashboards (summary view).

`read`

Update A Dashboard`betterstack_update_dashboard`

Updates an existing dashboard by its ID.

`write`

Create Heartbeat Group`betterstack_create_a_new_heartbeat_group`

Create a heartbeat group to organize heartbeat monitors.

`write`

Remove Heartbeat Group`betterstack_remove_heartbeat_group`

Permanently deletes an existing heartbeat group.

`write`

Get Heartbeat Group`betterstack_get_a_single_heartbeat_group`

Get one heartbeat group by ID.

`read`

List Heartbeat Groups`betterstack_list_all_existing_heartbeat_groups`

List heartbeat groups.

`read`

Update Heartbeat Group`betterstack_update_an_existing_heartbeat_group`

Update the attributes of an existing heartbeat group.

`write`

Create A Heartbeat`betterstack_create_heartbeat`

Create a heartbeat monitor that alerts when a cron job or scheduled task stops checking in.

`write`

Remove Heartbeat`betterstack_remove_heartbeat`

Permanently deletes an existing heartbeat.

`write`

Get A Heartbeat's Availability Summary`betterstack_get_a_heartbeats_availability_summary`

Get a heartbeat's availability summary, optionally for a date range.

`read`

Get A Single Heartbeat`betterstack_get_heartbeat`

Get one heartbeat monitor by ID.

`read`

List Heartbeats`betterstack_list_heartbeats`

List heartbeat monitors (cron jobs and scheduled tasks) with their current status.

`read`

Update Heartbeat`betterstack_update_heartbeat`

Update a heartbeat monitor; send only the fields to change.

`write`

Get Unified Credentials`betterstack_unified_get_me`

Get the current Better Stack connection's unified credentials and identity.

List Unified Roles`betterstack_unified_list_roles`

List unified roles in a Better Stack organization.

Get Unified Role`betterstack_unified_get_role`

Get a unified Better Stack role by ID.

List Unified Users`betterstack_unified_list_users`

List unified users in a Better Stack team.

Get Unified User`betterstack_unified_get_user`

Get a unified Better Stack user by ID.

Acknowledge Incident`betterstack_acknowledge_an_ongoing_incident`

Acknowledge an ongoing incident so it stops escalating.

`write`

Create Comment`betterstack_create_a_new_comment`

Add a comment to an incident.

`write`

Create Incident`betterstack_create_a_new_incident`

Create an incident manually and alert the current on-call person.

`write`

Remove Comment`betterstack_remove_comment`

Permanently delete a comment from an incident.

`write`

Remove Incident`betterstack_remove_incident`

Permanently delete an incident.

`write`

Escalate Incident`betterstack_escalate_an_ongoing_incident`

Escalate an ongoing incident to a team member, a team, an escalation policy or the whole organization.

`write`

Get Comment`betterstack_get_comment`

Get one comment on an incident by ID.

`read`

Get Incident`betterstack_get_incident`

Get one incident by ID, including its cause, status and timestamps.

`read`

List Comments`betterstack_list_all_comments`

List all comments on an incident in one response.

`read`

List Incidents`betterstack_list_all_incidents`

List incidents, filtered by monitor, heartbeat, date range, or resolved and acknowledged state.

`read`

List Incident Timeline`betterstack_list_of_incident_timeline_events`

Get the full timeline of an incident (comments, alert payloads, responses and status report cards) in one response.

`read`

Reopen Incident`betterstack_reopen_a_resolved_incident`

Reopen a resolved incident.

`write`

Resolve Incident`betterstack_resolve_an_ongoing_incident`

Resolve an ongoing incident.

`write`

Update Comment`betterstack_update_a_comment`

Update a comment on an incident. Only comments created through the API can be updated.

`write`

List Metadata`betterstack_list_all_existing_metadata`

List metadata key-value records attached to monitors, heartbeats, incidents and integrations.

`read`

Update Metadata`betterstack_update_an_existing_metadata_record`

Create, update, or remove metadata values for specified key for given incident, monitor, or other resources.

`write`

Create Monitor Group`betterstack_create_a_new_monitor_group`

Create a monitor group to organize uptime monitors.

`write`

Remove Monitor Group`betterstack_remove_monitor_group`

Permanently deletes an existing monitor group.

`write`

List Monitors In Group`betterstack_list_monitor_group_monitors`

List the monitors in a monitor group.

`read`

Get Monitor Group`betterstack_get_single_monitor_group`

Get one monitor group by ID.

`read`

List Monitor Groups`betterstack_list_all_existing_monitor_groups`

List monitor groups.

`read`

Update Monitor Group`betterstack_update_an_existing_monitor_group`

Update the attributes of an existing monitor group.

`write`

Create Monitor`betterstack_create_a_new_monitor`

Create an uptime monitor (HTTP status, keyword, ping, TCP, UDP, SMTP, POP, IMAP, DNS or Playwright).

`write`

Remove Monitor`betterstack_remove_monitor`

Permanently deletes an existing monitor.

`write`

Monitor Availability`betterstack_get_a_monitors_availability_summary`

Get a monitor's availability (SLA) summary, optionally for a date range.

`read`

Get Monitor`betterstack_get_a_single_monitor`

Get one uptime monitor by ID, including its current status and check settings.

`read`

Monitor Response Times`betterstack_get_monitors_response_times`

Get a monitor's response times by region for the last 24 hours.

`read`

List Monitors`betterstack_list_all_existing_monitors`

List uptime monitors with their current status, filtered by URL or name.

`read`

Update Monitor`betterstack_update_an_existing_monitor`

Update a monitor; send only the fields to change. Set paused to pause or resume checks.

`write`

Create An On-call Schedule Event`betterstack_create_on_call_schedule_event`

Add an on-call shift (for example an override) to a schedule.

`write`

Create An On-call Schedule`betterstack_create_on_call_schedule`

Create a new on-call schedule.

`write`

Remove On-call Schedule Event`betterstack_remove_on_call_schedule_event`

Delete an on-call shift. Shifts starting before today 0:00 UTC cannot be deleted.

`write`

Remove On-call Schedule`betterstack_remove_on_call_schedule`

Permanently deletes an existing on-call schedule.

`write`

Get On-call Schedule`betterstack_get_on_call_schedule`

Get an on-call schedule and the users currently on call. Use default as schedule\_id for the team's default schedule.

`read`

Get An On-call Schedule Rotation`betterstack_get_on_call_schedule_rotation`

Get the rotation currently used by an on-call schedule.

`read`

Get A Single On-call Schedule Event`betterstack_get_on_call_schedule_event`

Get one on-call shift by ID.

`read`

List On-call Schedules`betterstack_list_on_call_schedules`

List on-call schedules.

`read`

List On-call Schedule Events`betterstack_list_on_call_schedule_events`

List the on-call shifts of a schedule, optionally within a time window.

`read`

Update On-call Schedule Event`betterstack_update_on_call_schedule_event`

Update an on-call shift. Shifts starting before today 0:00 UTC cannot be changed.

`write`

Update An On-call Schedule`betterstack_update_on_call_schedule`

Update an existing on-call schedule.

`write`

Create Escalation Policy`betterstack_create_escalation_policy`

Create an escalation policy: the ordered steps that decide who is alerted for an incident and when.

`write`

Remove Escalation Policy`betterstack_remove_escalation_policy`

Permanently deletes an existing escalation policy.

`write`

Get Escalation Policy`betterstack_get_a_single_escalation_policy`

Get one escalation policy by ID, including its steps.

`read`

List Escalation Policies`betterstack_list_all_escalation_policies`

List escalation policies, used to route and escalate incidents.

`read`

Update Escalation Policy`betterstack_update_escalation_policy`

Update an existing escalation policy.

`write`

Create A Release`betterstack_create_release`

Register a release (for example from CI at deploy time) so errors can be tied to it.

`write`

Remove A Release`betterstack_remove_release`

Remove a release. A release that still receives errors is detected again automatically.

`write`

Get A Single Release`betterstack_get_release`

Get one error tracking release by ID.

`read`

List All Releases`betterstack_list_releases`

List error tracking releases.

`read`

List Roles`betterstack_list_roles`

List the built-in and custom roles in a Better Stack organization.

Create Severity`betterstack_create_severity`

Create an incident severity that sets which channels (SMS, call, e-mail, push) alert the on-call person.

`write`

Remove Severity`betterstack_remove_severity`

Permanently deletes an existing severity.

`write`

Get Severity`betterstack_get_a_single_severity`

Get one incident severity by ID.

`read`

List Severities`betterstack_list_all_severities`

List incident severities, used when escalating or alerting.

`read`

Update Severity`betterstack_update_severity`

Update an existing severity.

`write`

Get Severity Group`betterstack_get_severity_group`

Get one severity group by ID.

`read`

List Severity Groups`betterstack_list_severity_groups`

List severity groups, which organize incident severities. create\_severity and update\_severity take their IDs.

`read`

Create A Source Group`betterstack_create_a_source_group`

Create a source group to organize telemetry sources.

`write`

Remove A Source Group`betterstack_remove_source_group`

Permanently deletes an existing source group.

`write`

Get A Single Source Group`betterstack_get_source_group`

Get a single source group by its ID.

`read`

List All Source Groups`betterstack_list_all_existing_source_groups`

List telemetry source groups.

`read`

Update A Source Group`betterstack_update_source_group`

Updates an existing source group.

`write`

Create A Source`betterstack_create_a_source`

Create a log or metrics source for a platform; the response carries its ingestion token.

`write`

Remove A Source`betterstack_remove_source`

Permanently delete a telemetry source.

`write`

Get A Single Source`betterstack_get_a_single_source`

Get one telemetry source by ID, including its ingestion token and host.

`read`

List All Sources`betterstack_list_all_existing_sources`

List log and metrics sources (telemetry ingestion endpoints).

`read`

Update A Source`betterstack_update_source`

Update a telemetry source; send only the fields to change.

`write`

Create Status Page Report`betterstack_create_a_new_status_page_report`

Post an incident or maintenance report on a status page, with the affected resources and their status.

`write`

Create Status Page Resource`betterstack_create_a_new_status_page_resource`

Add a resource (a monitor, heartbeat, group or manually tracked item) to a status page.

`write`

Create Status Page`betterstack_create_a_new_status_page`

Create a status page with its company name, subdomain and timezone.

`write`

Create Status Update`betterstack_create_a_new_status_update`

Post a new status update on a status page report, optionally changing the affected resources.

`write`

Remove Status Page Report`betterstack_remove_status_page_report`

Permanently delete a status page report.

`write`

Remove Status Page Resource`betterstack_remove_status_page_resource`

Permanently deletes an existing status page resource.

`write`

Remove Status Page`betterstack_remove_status_page`

Permanently deletes an existing status page.

`write`

Get Status Page Report`betterstack_get_a_single_status_page_report`

Get one status page report by ID.

`read`

Get Status Page Resource`betterstack_get_a_single_status_page_resource`

Get one resource (component) of a status page by ID.

`read`

Get Status Page`betterstack_get_a_single_status_page`

Get one status page by ID.

`read`

Get Status Update`betterstack_get_a_single_status_update`

Get one status update of a status page report.

`read`

List Status Pages`betterstack_list_all_existing_status_pages`

List status pages.

`read`

List Status Updates Per Report`betterstack_list_all_existing_status_updates_for_a_status_page_report`

List the status updates posted on a status page report.

`read`

List Status Page Reports`betterstack_list_existing_reports_on_a_status_page`

List incident and maintenance reports posted on a status page.

`read`

List Status Page Resources`betterstack_list_existing_resources_of_a_status_page`

List the resources (components) shown on a status page, needed for affected\_resources on reports.

`read`

List Status Page Sections`betterstack_list_existing_sections_of_a_status_page`

List status page sections in Better Stack.

`read`

Update Status Page Report`betterstack_update_an_existing_status_page_report`

Update the title or timing of a status page report. Affected resources change through new status updates.

`write`

Update Status Page Resource`betterstack_update_an_existing_status_page_resource`

Update an existing status page resource.

`write`

Update Status Page`betterstack_update_an_existing_status_page`

Update an existing status page.

`write`

List Team Members`betterstack_list_team_members`

List members and pending invitations of a Better Stack team.

Get Team Member`betterstack_get_team_member`

Get a single Better Stack team member by ID.

Update Team Member Role`betterstack_update_team_member_role`

Changes a team member's role.

Remove A Team Member From Team By E-mail`betterstack_remove_team_member_by_email`

Removes a member from the team, or cancels a pending invitation, by their email address.

Remove A Team Member From Team By ID`betterstack_remove_team_member`

Removes a member from the team by their ID.

Invite A Team Member`betterstack_invite_team_member`

Invites a new user to your organization.

Get Usage Overview`betterstack_get_usage_overview`

Get the organization's usage and incurred cost across all Better Stack products.

Get Usage Per Product`betterstack_get_usage_per_product`

Get the organization's usage and incurred cost for one Better Stack product, itemized by line item.

## Events

Tags

Select all
|
Clear

Incidents

Monitors

No tags found

10 events

EventDescriptionTags

Incident Started`betterstack_webhook_incident_started`

Fired when an incident starts (a monitor or heartbeat fails, or an incident is created manually or over the API) in Bett...

Incidents

Incident Acknowledged`betterstack_webhook_incident_acknowledged`

Fired when someone acknowledges an ongoing incident in Better Stack.

Incidents

Incident Resolved`betterstack_webhook_incident_resolved`

Fired when an incident is resolved in Better Stack.

Incidents

Incident Reopened`betterstack_webhook_incident_reopened`

Fired when a resolved incident is reopened in Better Stack.

Incidents

Incident Comment Added`betterstack_webhook_incident_comment`

Fired when a comment is added to an incident in Better Stack.

Incidents

Monitor Created`betterstack_webhook_monitor_created`

Fired when a monitor is created in Better Stack.

Monitors

Monitor Updated`betterstack_webhook_monitor_updated`

Fired when a monitor's settings change in Better Stack.

Monitors

Monitor Paused`betterstack_webhook_monitor_paused`

Fired when a monitor is paused in Better Stack.

Monitors

Monitor Unpaused`betterstack_webhook_monitor_unpaused`

Fired when a paused monitor is resumed in Better Stack.

Monitors

Monitor Deleted`betterstack_webhook_monitor_deleted`

Fired when a monitor is deleted in Better Stack.

Monitors


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.