Skip to main content
Better Stack
Previewv0.2.0
145 actions · 10 events · 4 auth methods
ObservabilityIAM

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.

Global API Token · Connector Profile

Works with every Better Stack product (Incidents, Telemetry, Errors) and every team. Needs the team name when the organi…

Incidents API Token · Connector Profile

Scoped to one team. Reaches monitors, heartbeats, incidents, on-call, status pages, team members and roles. Other produc…

Telemetry API Token · Connector Profile

Scoped to one team. Reaches sources, dashboards, alerts and Errors applications and releases. Other products and the usa…

OAuth 2.0 · Connector Profile

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.

Webhooks setup

3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Global API Token · Link Account

Incidents API Token · Link Account

Telemetry API Token · Link Account

OAuth 2.0 · Link Account

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

|
|
145 actions
Action
Description
Required scopes
Remove An Alert
Permanently delete an alert by ID, whether it is on a dashboard chart or an exploration.
Get A Single Alert
Get one telemetry alert by ID.
List All Alerts
List all telemetry alerts across dashboards and explorations.
Update An Alert
Update an alert by ID, whether it is on a dashboard chart or an exploration.
Create An Application
Creates a new error tracking application.
Remove An Application
Deletes an existing error tracking application.
Get A Single Application
Get one error tracking application by ID.
List All Applications
List error tracking applications.
Update An Application
Updates an existing error tracking application.
Create Catalog Attribute
Add an attribute (column) to a Catalog relation.
Create Catalog Record
Add a record to a Catalog relation, giving a value for each of its attributes.
Create Catalog Relation
Create a Catalog relation, a custom inventory such as services or teams.
Remove Catalog Attribute
Permanently deletes an existing Catalog attribute.
Remove Catalog Record
Permanently deletes an existing Catalog record.
Remove Catalog Relation
Permanently deletes an existing Catalog relation.
List Catalog Attributes
List the attributes (columns) of a Catalog relation; create_catalog_record needs their IDs.
List Catalog Records
List the records of a Catalog relation.
List Catalog Relations
List Catalog relations, the custom inventories (such as services or teams) defined in Better Stack.
Get Catalog Attribute
Get one attribute of a Catalog relation by ID.
Get A Single Catalog Record
Get one Catalog record by ID.
Get Catalog Relation
Get one Catalog relation by ID, including its attributes.
Update Catalog Attribute
Update an existing Catalog attribute.
Update Catalog Record
Update an existing Catalog record.
Update Catalog Relation
Update an existing Catalog relation.
Create A Dashboard Group
Creates a new dashboard group for organizing dashboards.
Remove A Dashboard Group
Permanently deletes a dashboard group by its ID.
Get A Single Dashboard Group
Retrieves a single dashboard group by its ID.
List All Dashboard Groups
Retrieves a paginated list of your team’s dashboard groups.
Update A Dashboard Group
Updates an existing dashboard group by its ID.
Create A Dashboard Alert
Creates a new alert for a specific dashboard chart.
Create A Dashboard
Creates a new dashboard, including its variables and other properties.
Remove A Dashboard
Permanently deletes an existing dashboard.
Get A Single Dashboard
Get one dashboard by ID, including its charts, sections and variables.
List All Dashboards
List telemetry dashboards (summary view).
Update A Dashboard
Updates an existing dashboard by its ID.
Create Heartbeat Group
Create a heartbeat group to organize heartbeat monitors.
Remove Heartbeat Group
Permanently deletes an existing heartbeat group.
Get Heartbeat Group
Get one heartbeat group by ID.
List Heartbeat Groups
List heartbeat groups.
Update Heartbeat Group
Update the attributes of an existing heartbeat group.
Create A Heartbeat
Create a heartbeat monitor that alerts when a cron job or scheduled task stops checking in.
Remove Heartbeat
Permanently deletes an existing heartbeat.
Get A Heartbeat’s Availability Summary
Get a heartbeat’s availability summary, optionally for a date range.
Get A Single Heartbeat
Get one heartbeat monitor by ID.
List Heartbeats
List heartbeat monitors (cron jobs and scheduled tasks) with their current status.
Update Heartbeat
Update a heartbeat monitor; send only the fields to change.
Get Unified Credentials
Get the current Better Stack connection’s unified credentials and identity.
List Unified Roles
List unified roles in a Better Stack organization.
Get Unified Role
Get a unified Better Stack role by ID.
List Unified Users
List unified users in a Better Stack team.
Get Unified User
Get a unified Better Stack user by ID.
Acknowledge Incident
Acknowledge an ongoing incident so it stops escalating.
Create Comment
Add a comment to an incident.
Create Incident
Create an incident manually and alert the current on-call person.
Remove Comment
Permanently delete a comment from an incident.
Remove Incident
Permanently delete an incident.
Escalate Incident
Escalate an ongoing incident to a team member, a team, an escalation policy or the whole organization.
Get Comment
Get one comment on an incident by ID.
Get Incident
Get one incident by ID, including its cause, status and timestamps.
List Comments
List all comments on an incident in one response.
List Incidents
List incidents, filtered by monitor, heartbeat, date range, or resolved and acknowledged state.
List Incident Timeline
Get the full timeline of an incident (comments, alert payloads, responses and status report cards) in one response.
Reopen Incident
Reopen a resolved incident.
Resolve Incident
Resolve an ongoing incident.
Update Comment
Update a comment on an incident. Only comments created through the API can be updated.
List Metadata
List metadata key-value records attached to monitors, heartbeats, incidents and integrations.
Update Metadata
Create, update, or remove metadata values for specified key for given incident, monitor, or other resources.
Create Monitor Group
Create a monitor group to organize uptime monitors.
Remove Monitor Group
Permanently deletes an existing monitor group.
List Monitors In Group
List the monitors in a monitor group.
Get Monitor Group
Get one monitor group by ID.
List Monitor Groups
List monitor groups.
Update Monitor Group
Update the attributes of an existing monitor group.
Create Monitor
Create an uptime monitor (HTTP status, keyword, ping, TCP, UDP, SMTP, POP, IMAP, DNS or Playwright).
Remove Monitor
Permanently deletes an existing monitor.
Monitor Availability
Get a monitor’s availability (SLA) summary, optionally for a date range.
Get Monitor
Get one uptime monitor by ID, including its current status and check settings.
Monitor Response Times
Get a monitor’s response times by region for the last 24 hours.
List Monitors
List uptime monitors with their current status, filtered by URL or name.
Update Monitor
Update a monitor; send only the fields to change. Set paused to pause or resume checks.
Create An On-call Schedule Event
Add an on-call shift (for example an override) to a schedule.
Create An On-call Schedule
Create a new on-call schedule.
Remove On-call Schedule Event
Delete an on-call shift. Shifts starting before today 0:00 UTC cannot be deleted.
Remove On-call Schedule
Permanently deletes an existing on-call schedule.
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.
Get An On-call Schedule Rotation
Get the rotation currently used by an on-call schedule.
Get A Single On-call Schedule Event
Get one on-call shift by ID.
List On-call Schedules
List on-call schedules.
List On-call Schedule Events
List the on-call shifts of a schedule, optionally within a time window.
Update On-call Schedule Event
Update an on-call shift. Shifts starting before today 0:00 UTC cannot be changed.
Update An On-call Schedule
Update an existing on-call schedule.
Create Escalation Policy
Create an escalation policy: the ordered steps that decide who is alerted for an incident and when.
Remove Escalation Policy
Permanently deletes an existing escalation policy.
Get Escalation Policy
Get one escalation policy by ID, including its steps.
List Escalation Policies
List escalation policies, used to route and escalate incidents.
Update Escalation Policy
Update an existing escalation policy.
Create A Release
Register a release (for example from CI at deploy time) so errors can be tied to it.
Remove A Release
Remove a release. A release that still receives errors is detected again automatically.
Get A Single Release
Get one error tracking release by ID.
List All Releases
List error tracking releases.
List Roles
List the built-in and custom roles in a Better Stack organization.
Create Severity
Create an incident severity that sets which channels (SMS, call, e-mail, push) alert the on-call person.
Remove Severity
Permanently deletes an existing severity.
Get Severity
Get one incident severity by ID.
List Severities
List incident severities, used when escalating or alerting.
Update Severity
Update an existing severity.
Get Severity Group
Get one severity group by ID.
List Severity Groups
List severity groups, which organize incident severities. create_severity and update_severity take their IDs.
Create A Source Group
Create a source group to organize telemetry sources.
Remove A Source Group
Permanently deletes an existing source group.
Get A Single Source Group
Get a single source group by its ID.
List All Source Groups
List telemetry source groups.
Update A Source Group
Updates an existing source group.
Create A Source
Create a log or metrics source for a platform; the response carries its ingestion token.
Remove A Source
Permanently delete a telemetry source.
Get A Single Source
Get one telemetry source by ID, including its ingestion token and host.
List All Sources
List log and metrics sources (telemetry ingestion endpoints).
Update A Source
Update a telemetry source; send only the fields to change.
Create Status Page Report
Post an incident or maintenance report on a status page, with the affected resources and their status.
Create Status Page Resource
Add a resource (a monitor, heartbeat, group or manually tracked item) to a status page.
Create Status Page
Create a status page with its company name, subdomain and timezone.
Create Status Update
Post a new status update on a status page report, optionally changing the affected resources.
Remove Status Page Report
Permanently delete a status page report.
Remove Status Page Resource
Permanently deletes an existing status page resource.
Remove Status Page
Permanently deletes an existing status page.
Get Status Page Report
Get one status page report by ID.
Get Status Page Resource
Get one resource (component) of a status page by ID.
Get Status Page
Get one status page by ID.
Get Status Update
Get one status update of a status page report.
List Status Pages
List status pages.
List Status Updates Per Report
List the status updates posted on a status page report.
List Status Page Reports
List incident and maintenance reports posted on a status page.
List Status Page Resources
List the resources (components) shown on a status page, needed for affected_resources on reports.
List Status Page Sections
List status page sections in Better Stack.
Update Status Page Report
Update the title or timing of a status page report. Affected resources change through new status updates.
Update Status Page Resource
Update an existing status page resource.
Update Status Page
Update an existing status page.
List Team Members
List members and pending invitations of a Better Stack team.
Get Team Member
Get a single Better Stack team member by ID.
Update Team Member Role
Changes a team member’s role.
Remove A Team Member From Team By E-mail
Removes a member from the team, or cancels a pending invitation, by their email address.
Remove A Team Member From Team By ID
Removes a member from the team by their ID.
Invite A Team Member
Invites a new user to your organization.
Get Usage Overview
Get the organization’s usage and incurred cost across all Better Stack products.
Get Usage Per Product
Get the organization’s usage and incurred cost for one Better Stack product, itemized by line item.

Events

|
10 events
Event
Description
Tags
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
Fired when someone acknowledges an ongoing incident in Better Stack.
Incidents
Incident Resolved
Fired when an incident is resolved in Better Stack.
Incidents
Incident Reopened
Fired when a resolved incident is reopened in Better Stack.
Incidents
Incident Comment Added
Fired when a comment is added to an incident in Better Stack.
Incidents
Monitor Created
Fired when a monitor is created in Better Stack.
Monitors
Monitor Updated
Fired when a monitor’s settings change in Better Stack.
Monitors
Monitor Paused
Fired when a monitor is paused in Better Stack.
Monitors
Monitor Unpaused
Fired when a paused monitor is resumed in Better Stack.
Monitors
Monitor Deleted
Fired when a monitor is deleted in Better Stack.
Monitors