Skip to main content
Better Stack logo
  • Category: server monitoring
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 117
  • Triggers: 0
  • Slug: BETTER_STACK
  • Version: 20261101_00

Tools

Slug: BETTER_STACK_ACKNOWLEDGE_INCIDENTTool to acknowledge an ongoing incident. Use when you need to mark an incident as being worked on, which prevents further escalations. Acknowledging an incident signals that someone is actively addressing the issue.

Input Parameters

string
required
The ID of the incident to acknowledge
string
Email or custom identifier of the person or system acknowledging the incident

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_BATCH_CREATE_CATALOG_RECORDS
Batch create catalog records Allows creation of multiple Catalog records at once. POST /api/v2/catalog/relations/{relation_id}/records/batch Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

array
required
Records sent as a raw JSON array. Each record contains an attributes array; entries contain attribute (id/name) and values (typed value or item_id objects). Follows the single Catalog record creation format.
string
required
The ID of the Catalog relation you want to create records for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_BATCH_REMOVE_CATALOG_RECORDS
Batch remove catalog records Permanently deletes all existing Catalog records for a given relation. DELETE /api/v2/catalog/relations/{relation_id}/records/batch Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Catalog relation you want to delete records for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_BATCH_UPDATE_CATALOG_RECORDS
Batch update catalog records Allows replacing all Catalog records for a given relation at once. This is a destructive operation and will remove all existing records for the relation before creating new ones. PUT /api/v2/catalog/relations/{relation_id}/records/batch Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

array
required
Array of records to be created. Each individual records follows the format for creating a single Catalog record.
string
required
The ID of the Catalog relation you want to replace records for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_BATCH_UPSERT_CATALOG_RECORDSCreate or partially update Catalog records in one atomic batch. Matches existing records by primary attribute values, regardless of value order; an empty primary attribute matches only an empty one. Matching records update only supplied attributes: omitted attributes retain their values, and an empty values array clears an attribute. Nonmatching inputs create records; existing records not matched by the batch remain unchanged. If any record cannot be saved, none are saved, including ambiguous matches or duplicate primary values within the batch. Returns records in input order and created/updated IDs. Requires a Better Stack Incidents API token with access to the relation.

Input Parameters

array
required
Records to create or update. Each record contains an attributes array of objects with attribute (id and/or name) and values. Values contain type and type-specific fields, such as value for String or email for User. Omitted attributes keep their values; an empty values array clears an attribute.
string
required
The ID of the Catalog relation you want to create or update records for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_BULK_UPDATE_ON_CALL_EVENTS
Bulk update on-call schedule events Replace all current and future on-call events in a single on-call schedule: - Delete all events that start today at 0:00 UTC or later. - Create new events. All newly created events also must start today at 0:00 UTC or later. PUT /api/v2/on-calls/{schedule_id}/events Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

array
required
Events to create, each containing users (array of email addresses), starts_at and ends_at (ISO 8601 timestamps), and optional override (boolean). Replaces all events starting today at 00:00 UTC or later; new events must also start at or after that cutoff. Earlier events remain unchanged. Use the single-event structure: https://betterstack.com/docs/uptime/api/create-on-call-calendar-event/.
string
required
The ID of the on-call schedule you want to replace events for. Use default to refer to the default on-call schedule for the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_AMAZON_SNS_INTEGRATION
Create Amazon SNS integration Returns either a newly created Amazon SNS integration, or validation errors. Subscribe a topic to the returned url to start receiving notifications, as described in the Amazon SNS integration guide. Leave Enable raw message delivery off on that subscription, or every notification is rejected with 400. POST /api/v2/amazon-sns Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

boolean
Send an SMS to the on-call person.
boolean
Call the on-call person.
string
The name of the Amazon SNS integration that you can see in the dashboard.
boolean
Send a push notification to the on-call person.
boolean
Send an e-mail to the on-call person.
boolean
Set to true to pause the integration, false to unpause it.
string
ID of the escalation policy for incidents from this integration. Without one, incidents alert the current on-call person through the channels set by call, sms, email, and push.
string
Required if using global API token to specify the team which should own the resource
integer
How long we wait before escalating the incident to the team. In seconds. Send null to never escalate to the team, or 0 to alert the whole team right away.
object
Incident cause extraction object; defaults to the whole message. Required string keys: field_target (sns_envelope, body, json, xml, query_string, header) and match_type (match_everything, match_before, match_after, match_between, match_regex). target_field: dot path for json/query_string, header name, XML CSS selector, or TopicArn/MessageId/Subject for sns_envelope; unused for body. body/json/xml read the published message; query_string/header read AWS’s HTTPS request, not the message. match_everything takes the whole value. match_before/match_after require string content and extract text before/after it. match_regex requires a regex in content and extracts its match or capture group. match_between requires string content_before and content_after delimiters.
object
How to extract a custom incident title, as a field object with the same keys as cause_field. Defaults to the notification’s Subject, and null removes it to use the default title.
array
The conditions started_rule_type checks, as an array of rule objects with the keys below. At least one rule is required when the type is any or all. Nested fields: started_rules[].rule_target: Which part of the notification the rule checks: sns_envelope for the envelope, body, json, or xml for the message your publisher sent, or query_string or header for AWS’s own HTTPS request, which never contains your message.; started_rules[].target_field: Which value to read: a dot-separated path such as alert.id for json and query_string, a header name for header, a CSS selector for xml, or TopicArn, MessageId, or Subject for sns_envelope. Not used with body.; started_rules[].match_type: How to compare the value with content: contains, contains_not, equals, equals_not, matches_regex, or matches_regex_not.; started_rules[].content: The value to compare with. Must be a valid regular expression for matches_regex and matches_regex_not.
boolean
Send a critical push notification that ignores the mute switch and Do Not Disturb mode.
array
The conditions resolved_rule_type checks, as rule objects with the same keys as started_rules.
integer ("0" | "60" | "180" | "300" | "900" | "1800" | "3600" | "7200")
How long to wait after a notification matching resolved_rules arrives before marking an incident as resolved, in seconds: 0, 60, 180, 300, 900, 1800, 3600, or 7200. Has no effect while resolved_rule_type is unused.
string ("unused" | "any" | "all")
When notifications start an incident: unused always, any when at least one of started_rules matches, or all when all of them match. Defaults to unused.
array
The conditions acknowledged_rule_type checks, as rule objects with the same keys as started_rules.
string ("unused" | "any" | "all")
When notifications resolve an incident: unused never, any when at least one of resolved_rules matches, or all when all of them match. Defaults to unused, and any other value requires started_alert_id_field and resolved_alert_id_field.
array
Extra values to extract when an incident starts, saved as incident metadata. Each field object has the same keys as cause_field, plus name. Nested fields: other_started_fields[].name: The metadata key to save the extracted value under. Must be unique within the array.
array
Extra values to extract when an incident is resolved, with the same keys as other_started_fields.
string ("unused" | "any" | "all")
When notifications acknowledge an incident: unused never, any when at least one of acknowledged_rules matches, or all when all of them match. Defaults to unused, and any other value requires started_alert_id_field and acknowledged_alert_id_field.
object
How to extract the alert ID from the notification that starts an incident, with the same keys as cause_field; later notifications acknowledge and resolve the incident by matching it. Required when acknowledged_rule_type or resolved_rule_type isn’t unused, and defaults to the whole message.
object
How to extract the alert ID from a notification that resolves an incident, with the same keys as cause_field. Required when resolved_rule_type isn’t unused.
array
Extra values to extract when an incident is acknowledged, with the same keys as other_started_fields.
object
How to extract the alert ID from a notification that acknowledges an incident, with the same keys as cause_field. Required when acknowledged_rule_type isn’t unused.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_AWS_CLOUDWATCH_INTEGRATION
Create AWS CloudWatch integration Returns either a newly created AWS CloudWatch integration, or validation errors. POST /api/v2/aws-cloudwatch-integrations Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

boolean
Send an SMS to the on-call person.
boolean
Call the on-call person.
string
The name of the AWS CloudWatch integration that you can see in the dashboard.
boolean
Send a push notification to the on-call person.
boolean
Send an e-mail to the on-call person.
boolean
Set to true to pause the integration, false to unpause it.
string
ID of the escalation policy associated with the AWS CloudWatch integration.
string
Required if using global API token to specify the team which should own the resource
integer
How long we wait before escalating the incident alert to the team. In seconds.
boolean
Send a critical push notification that ignores the mute switch and Do not Disturb mode.
integer
Has no effect for this integration, since an incident resolves as soon as AWS CloudWatch reports the alert as resolved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_AWS_LOG_GROUP_SUBSCRIPTIONCreate an override to subscribe or unsubscribe one CloudWatch log group. Requires an aws source with an AWS account already connected and a Telemetry API token with access to the source. Set subscribed to true to ingest the log group or false to skip it, overriding the source’s automatic subscription setting. An override can be created before discovery of the log group; creating a duplicate region/name override returns HTTP 422.

Input Parameters

string
required
Name of the CloudWatch log group, for example /aws/lambda/checkout.
string
required
AWS region of the log group, for example us-east-1.
string
required
ID of an aws source with an AWS account already connected.
boolean
required
Whether to ingest this log group. Set to true to subscribe or false to skip it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_AZURE_INTEGRATION
Create Azure integration Returns either a newly created Azure integration, or validation errors. POST /api/v2/azure-integrations Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

boolean
Send an SMS to the on-call person.
boolean
Call the on-call person.
string
The name of the Azure integration that you can see in the dashboard.
boolean
Send a push notification to the on-call person.
boolean
Send an e-mail to the on-call person.
boolean
Set to true to pause the integration, false to unpause it.
string
ID of the escalation policy associated with the Azure integration.
string
Required if using global API token to specify the team which should own the resource
integer
How long we wait before escalating the incident alert to the team. In seconds.
boolean
Send a critical push notification that ignores the mute switch and Do not Disturb mode.
integer
Has no effect for this integration, since an incident resolves as soon as Azure reports the alert as resolved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_CATALOG_ATTRIBUTE
Create catalog attribute Returns either a newly created Catalog attribute, or validation errors. POST /api/v2/catalog/relations/{relation_id}/attributes Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The name of the Catalog attribute.
boolean
Whether this is a primary attribute. Primary attributes are matched against the incident metadata key of the same name, the other attributes are added to matching incidents as metadata. Defaults to false.
integer
The position of the attribute in the Catalog relation, lower values first. Defaults to 0.
string
required
The ID of the Catalog relation you want to create an attribute for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_CATALOG_RECORD
Create catalog record Returns either a newly created Catalog record, or validation errors. POST /api/v2/catalog/relations/{relation_id}/records Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

array
required
Record attributes: [{attribute: {id or name}, values: [{type, value or item_id/name/email}]}]. Attribute id/name and value identifiers are strings. Each value requires type: String, User, Team, Policy, Schedule, Endpoint, Source, SlackIntegration, LinearIntegration, JiraIntegration, MicrosoftTeamsWebhook, ZapierWebhook, NativeWebhook, or PagerDutyWebhook. String requires value. References require item_id, name, or email (email for User); Endpoint references a monitor ID. Endpoint, SlackIntegration and ZapierWebhook cannot be referenced by name. Multiple values per attribute are supported.
string
required
The ID of the Catalog relation you want to create a record for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_CATALOG_RELATION
Create catalog relation Returns either a newly created Catalog relation, or validation errors. POST /api/v2/catalog/relations Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The name of the Catalog relation.
string ("any" | "all")
any, the default, applies a record when at least one of its primary attribute values matches the incident’s metadata. all applies it only when every primary attribute value matches, with an empty value matching anything.
string
A description of the Catalog relation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_CHARTCreate a chart on a specific dashboard. Requires a Telemetry API token. Only line_chart supports multiple queries. funnel_chart cannot be created through the API. For SQL queries, filter dt with {{start_time}} and {{end_time}}; {{time}} only groups timestamps into buckets. Overlapping positions cause automatic layout consolidation; the response may include warnings.

Input Parameters

string
The name of the chart.
integer
The width of the chart in grid units. Defaults to 6 when omitted.
integer
The height of the chart in grid units. Defaults to 4 when omitted.
array
required
One or more query objects. Only line_chart supports multiple queries. Use query_type sql_expression with sql_query, tail_query with where_condition, or static_text with static_text. source_variable defaults to source. query_builder, pql_expression, and funnel_query are read-only.
object
A JSON object for chart-specific settings (e.g., units, stacking).
string
required
The type of chart to create (e.g., line_chart, bar_chart, table_chart).
string
A description for the chart.
integer
required
The unique identifier of the dashboard.
integer
The vertical position of the chart on the dashboard grid (0-based). If omitted, the chart is auto-placed.
integer
The horizontal position of the chart on the dashboard grid (0-based). If omitted, the chart is auto-placed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_CHART_COMMENT
Create a chart comment Pins a comment to a point in time on a chart, the same comment you get by clicking the chart in the Better Stack interface. Use it to mark releases, deployments, and incidents on your charts from your own scripts. POST /api/v2/dashboards/{dashboard_id}/charts/{chart_id}/comments Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
The content of the comment. Markdown is supported for formatting.
integer
required
The unique identifier of the chart. Only a line chart can show comments.
string
required
The point on the chart’s time axis to pin the comment to, as a datetime such as 2026-08-17T12:34:56.789Z. A datetime without a zone offset is read as UTC.
string
E-mail of a team member to tag in the comment. The mention goes in front of your content, and that team member is notified.
integer
required
The unique identifier of the dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_COLLECTOR
Create a collector Creates a new Better Stack collector. [info] The platform and data_region attributes can only be set during creation and cannot be updated later. A custom bucket can only be added during creation; its key pair can be rotated with Update collector. [/info] POST /api/v1/collectors Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
A unique name for the collector.
string
An optional note for the collector.
string ("docker" | "swarm" | "kubernetes")
required
The platform where the collector will be installed. Valid options are docker, swarm, and kubernetes.
array
An array of database connection objects to be monitored by the collector.
string
Required if using a global API token to specify the team that will own the collector.
string
The data region where the collector’s data will be stored. If omitted, the organization’s default region is used.
object
Collector configuration: components (boolean flags), logs_sample_rate/traces_sample_rate (0-100), vrl_transformation, disk_batch_size_mb (minimum 256), memory_batch_size_mb, when_full (drop_newest or block), log_line_length_limit_kb (4-128, default 8), services_options, and namespaces_options. Omitted components use provider defaults.
object
Configuration for storing data in your own S3-compatible bucket, as an object with the keys below. Nested fields: custom_bucket.endpoint: The full URL endpoint of the S3-compatible bucket, with no path after the bucket name. Example: https://s3.us-east-1.amazonaws.com/storage-bucket. ; custom_bucket.access_key_id: The access key ID of the key pair that has permissions to access this bucket.; custom_bucket.secret_access_key: The secret access key of the key pair that has permissions to access this bucket.; custom_bucket.keep_data_after_retention: Whether we should keep data in the bucket after the retention period instead of removing it. Defaults to false.
integer
Custom retention period for logs, in days. This is only available on select plans.
integer
The ID of the resource group to assign the collector’s associated sources to.
boolean
Set to true to create the collector in a paused state, preventing it from ingesting data.
string
A custom format for messages displayed in live tail, with columns wrapped in {column} brackets. Example: "PID: {message_json.pid} {level} {message}". For details, see Live tail docs.
integer
Custom retention period for metrics, in days. This is only available on select plans.
string
A custom Vector configuration in YAML format to be merged with the collector’s generated configuration.
string
A VRL program to be applied to logs server-side during ingestion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_COLLECTOR_METRIC_TARGET
Create a collector metric target Creates a new monitoring target on a collector. [info] Each target kind accepts a specific set of connection fields. Sending a field that does not apply to the chosen kind (for example, ssl_mode on a redis target) will return a validation error. [/info] POST /api/v1/collectors/{collector_id}/targets Requires a Telemetry API token with access to the resource.

Input Parameters

string ("false" | "true" | "skip-verify" | "preferred")
The TLS mode for the connection. Required for mysql. Valid options are false, true, skip-verify, and preferred.
string
required
The hostname or IP address of the target.
string ("postgres" | "mysql" | "redis" | "mongodb" | "memcached" | "elasticsearch" | "nginx" | "apache" | "kafka" | "prometheus")
required
The type of target. Valid options are postgres, mysql, redis, mongodb, memcached, elasticsearch, nginx, apache, kafka, and prometheus.
integer
The port number. Required for database kinds, optional for process kinds.
string ("http" | "https")
The connection scheme. Only accepted for elasticsearch. Valid options are http and https. Defaults to http if omitted.
string
An API key for authentication. Only accepted for elasticsearch. Write-only - never returned in responses.
boolean
Set to false to create the target in a disabled state. Defaults to true.
string
The service or container name. Required for nginx, apache, kafka, prometheus.
string
The full scrape URL, e.g. http://10.0.0.5:9090/metrics. Required for prometheus targets.
string
The password for authentication. Only accepted for databases and elasticsearch. Write-only - never returned in responses.
string ("disable" | "require" | "verify-ca")
The SSL mode for the connection. Required for postgres. Valid options are disable, require, and verify-ca.
string
The username for authentication. Only accepted for databases and elasticsearch.
string
The IP address the process listens on. Only accepted for nginx, apache, and kafka.
string
required
Identifier of the collector.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_CONNECTIONCreate a ClickHouse connection using a global API token, not a team token. The password is returned only in this creation response and cannot be retrieved later. Connections are organization-wide; optionally scope data access with either team_names or team_ids, not both. Omit data_region to create the connection in all regions; private cluster names are also accepted.

Input Parameters

string
A descriptive note for the connection.
array
Array of team IDs to associate with the connection. Connections are organization-wide, but can be scoped to specific teams for data access control. Only one of team_names or team_ids should be provided.
array
Array of team names to associate with the connection. Connections are organization-wide, but can be scoped to specific teams for data access control. Only one of team_names or team_ids should be provided.
string
required
Type of client connection. Currently only clickhouse is supported.
string
Data region or private cluster name to create the connection in. Permitted values for most plans are: us_east, germany, singapore. Omit to create the connection in all regions.
string
ISO 8601 timestamp when the connection expires.
array
Array of IP addresses or CIDR ranges that are allowed to use this connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_DASHBOARD
Create a dashboard Creates a new dashboard, including its variables and other properties. POST /api/v2/dashboards Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
The name of the dashboard.
string
Required if using a global API token to specify which team should own the resource.
array
Custom query variable objects with name, variable_type, values, default_values, sql_definition, and allow_multiple_values. sql_definition is required for select_with_sql. allow_multiple_values applies to select_value and select_with_sql and defaults to false. Default variables (time, start_time, end_time, source) are created automatically if not provided.
string
The end of the dashboard’s date range.
string
The start of the dashboard’s date range.
integer
Refresh interval in seconds. 0 means no refresh.
integer
The ID of a dashboard group to organize this dashboard.
string
An SQL filter determining which sources can be used with this dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_DASHBOARD_ALERT
Create a dashboard alert Creates a new alert for a specific dashboard chart. POST /api/v2/dashboards/{dashboard_id}/charts/{chart_id}/alerts Requires a Telemetry API token with access to the resource.

Input Parameters

boolean
Enable SMS notifications. Only used if escalation_target is not a policy.
boolean
Enable phone call notifications. Only used if escalation_target is not a policy.
string
required
The name of the alert.
boolean
Enable push notifications. Only used if escalation_target is not a policy.
boolean
Enable e-mail notifications. Only used if escalation_target is not a policy.
number
The numeric value for the alert condition. For threshold alerts, this is the static threshold. For relative alerts, this is the percentage change. Required for threshold and relative types unless string_value is set. A value of 0 is valid.
boolean
Set to true to create the alert in a paused state.
integer
required
The unique identifier of the chart.
object
A key-value object for custom metadata to be included in incidents. Both keys and values must be strings. For details, see Metadata.
string ("equal" | "not_equal" | "higher_than" | "higher_than_or_equal" | "lower_than" | "lower_than_or_equal" | "increases_by" | "decreases_by" | "changes_by")
The comparison operator. Required for threshold and relative alerts. For threshold: equal, not_equal, higher_than, higher_than_or_equal, lower_than, lower_than_or_equal. For relative: increases_by, decreases_by, changes_by. Not used for anomaly_rrcf alerts.
string ("threshold" | "relative" | "anomaly_rrcf")
required
The type of alert. threshold for static values, relative for percentage changes, or anomaly_rrcf for ML-based anomaly detection.
string ("source_variable" | "platforms_single_source" | "platforms_all_sources")
The mode for source selection. Valid values: source_variable, platforms_single_source, platforms_all_sources.
integer
How often to evaluate the alert condition, in seconds. Required for threshold and relative alert types. Not used for anomaly_rrcf alerts.
integer
required
The unique identifier of the dashboard.
integer
The time window in seconds for the data being analyzed. If not provided, falls back to aggregation_interval, then check_period.
array
An array of strings to filter the alert to specific data series. Cannot be combined with series_names_except. Send an empty array to alert on any series.
string
An alternative to value for threshold alerts when matching an exact string. If string_value is set, value is not required. Only valid with equal or not_equal operators.
string
A custom name template for the incident created by this alert, in plain text. Supports the same variables as incident_cause, such as {{alert_name}} and {{series_name}}. When empty, the incident is named after the dashboard and the alert.
boolean
Enable critical push notifications that bypass Do Not Disturb. Only used if escalation_target is not a policy.
string
A custom description template for the incident created by this alert. Supports {{value}} placeholder.
string ("any" | "higher" | "lower")
Defines which anomalies trigger an alert: any (both higher and lower), higher, or lower. Only for anomaly_rrcf alerts.
string ("treat_as_zero" | "dont_fire" | "treat_as_previous" | "start_incident")
What to do when the query returns no data: treat_as_zero, dont_fire, treat_as_previous, or start_incident. Only for threshold and relative alerts. Default: dont_fire.
integer
The duration in seconds that a condition must be resolved before an incident is recovered. A value of 0 recovers the incident immediately, null means never automatically recover an incident. Default: 60.
string
The variable name for the source selection. If not provided, derived automatically from the dashboard preset’s source variable.
array
An array of platform names to filter the sources this alert runs on.
string
Defines where to send notifications. Defaults to current_team, for details see Escalation targets.
number
How far the value must deviate from its predicted value to trigger an alert, from 1 to 10. Higher values require a larger deviation and trigger fewer alerts. Shown as Significance in the app. Only for anomaly_rrcf alerts. Default: 5.
integer
The duration in seconds that a condition must be met before an alert is triggered. A value of 0 triggers the alert immediately. Default: 60.
boolean
Whether a separate incident will be created for each data series that triggers the alert.
array
An array of strings to alert on all data series except the listed ones. Cannot be combined with series_names.
integer
The size of data buckets in seconds for aggregating and evaluating the metric. If not provided, falls back to query_period, then check_period.
array
An array of up to 4 additional conditions, each combined with the primary condition using logical AND, so the alert only fires where every condition is breached in the same time bucket. Each condition is an object with an alert_type of threshold or relative, an operator, a value or string_value, and an optional series_names or series_names_except scope. Anomaly detection cannot be used as an additional condition. Send an empty array to clear all additional conditions. See Multiple conditions for an example.
integer
How many days of history the anomaly detection model is trained on, from 1 to 30. Only for anomaly_rrcf alerts. Default: 7.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_DASHBOARD_GROUP
Create a dashboard group Creates a new dashboard group for organizing dashboards. POST /api/v2/dashboard-groups Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
The name of the dashboard group.
string
Required if using a global API token to specify which team should own the resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_DASHBOARD_SECTION
Create a dashboard section Creates a new section on a specific dashboard. POST /api/v2/dashboards/{dashboard_id}/sections Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
The name of the section.
boolean
Whether the section should be collapsed by default. Defaults to false at the provider when omitted.
string
The explanation text shown for the section.
integer
required
The unique identifier of the dashboard.
integer
The vertical position of the section on the dashboard grid. If omitted, it’s placed below all existing items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_DATADOG_INTEGRATION
Create Datadog integration Returns either a newly created Datadog integration, or validation errors. POST /api/v2/datadog-integrations Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

boolean
Send an SMS to the on-call person.
boolean
Call the on-call person.
string
The name of the Datadog integration that you can see in the dashboard.
boolean
Send a push notification to the on-call person.
boolean
Send an e-mail to the on-call person.
boolean
Set to true to pause the integration, false to unpause it.
string
ID of the escalation policy associated with the Datadog integration.
string
Required if using global API token to specify the team which should own the resource
integer
How long we wait before escalating the incident alert to the team. In seconds.
string ("alert" | "alert_and_warn")
Should we alert only on alarms, or on both alarms and warnings. Possible values: alert, alert_and_warn. Defaults to alert.
boolean
Send a critical push notification that ignores the mute switch and Do not Disturb mode.
integer
Has no effect for this integration, since an incident resolves as soon as Datadog reports the alert as resolved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_ELASTIC_INTEGRATION
Create Elastic integration Returns either a newly created Elastic integration, or validation errors. POST /api/v2/elastic-integrations Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

boolean
Send an SMS to the on-call person.
boolean
Call the on-call person.
string
The name of the Elastic integration that you can see in the dashboard.
boolean
Send a push notification to the on-call person.
boolean
Send an e-mail to the on-call person.
boolean
Set to true to pause the integration, false to unpause it.
string
ID of the escalation policy associated with the Elastic integration.
string
Required if using global API token to specify the team which should own the resource
integer
How long we wait before escalating the incident alert to the team. In seconds.
boolean
Send a critical push notification that ignores the mute switch and Do not Disturb mode.
integer
Has no effect for this integration, since an incident resolves as soon as Elastic reports the alert as resolved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_EMAIL_INTEGRATION
Create e-mail integration Returns either a newly created e-mail integration, or validation errors. POST /api/v2/email-integrations Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

boolean
Send an SMS to the on-call person.
boolean
Call the on-call person.
string
The name of the e-mail integration that you can see in the dashboard.
boolean
Send a push notification to the on-call person.
boolean
Send an e-mail to the on-call person.
boolean
Set to true to pause the integration, false to unpause it.
string
ID of the escalation policy for incidents from this integration. Without one, incidents alert the current on-call person through the channels set by call, sms, email, and push.
string
Required if using global API token to specify the team which should own the resource
integer
How long we wait before escalating the incident to the team. In seconds. Send null to never escalate to the team, or 0 to alert the whole team right away.
object
How to extract the incident cause from the e-mail that starts an incident, as a field object with the keys below. Defaults to the whole subject. Nested fields: cause_field.field_target: Which part of the e-mail to read: from_email, subject, or body.; cause_field.match_type: What to extract: match_everything takes the whole value, match_before the text before content, match_after the text after content, match_between the text between content_before and content_after, and match_regex the match of the regular expression in content, or its capture group.; cause_field.content: The text to extract around for match_before and match_after, or the regular expression for match_regex. Required for those three.; cause_field.content_before: Where extraction starts for match_between. Required for match_between.; cause_field.content_after: Where extraction stops for match_between. Leave it empty to extract to the end.
object
How to extract a custom incident title, as a field object with the same keys as cause_field. Send null to remove it and use the default title.
array
The conditions started_rule_type checks, as an array of rule objects with the keys below. At least one rule is required when the type is any or all. Nested fields: started_rules[].rule_target: Which part of the e-mail the rule checks: from_email, subject, or body.; started_rules[].match_type: How to compare the value with content: contains, contains_not, equals, equals_not, matches_regex, or matches_regex_not.; started_rules[].content: The value to compare with. Must be a valid regular expression for matches_regex and matches_regex_not.
boolean
Send a critical push notification that ignores the mute switch and Do Not Disturb mode.
array
The conditions resolved_rule_type checks, as rule objects with the same keys as started_rules.
integer
How long to wait after an e-mail matching resolved_rules arrives before marking an incident as resolved, in seconds: 0, 60, 180, 300, 900, 1800, 3600, or 7200. Has no effect while resolved_rule_type is unused.
string ("unused" | "any" | "all")
When e-mails start an incident: unused always, any when at least one of started_rules matches, or all when all of them match. Defaults to unused.
array
The conditions acknowledged_rule_type checks, as rule objects with the same keys as started_rules.
string ("unused" | "any" | "all")
When e-mails resolve an incident: unused never, any when at least one of resolved_rules matches, or all when all of them match. Defaults to unused, and any other value requires started_alert_id_field and resolved_alert_id_field.
array
Extra values to extract when an incident starts, saved as incident metadata. Each field object has the same keys as cause_field, plus name. Nested fields: other_started_fields[].name: The metadata key to save the extracted value under. Must be unique within the array.
array
Extra values to extract when an incident is resolved, with the same keys as other_started_fields.
string ("unused" | "any" | "all")
When e-mails acknowledge an incident: unused never, any when at least one of acknowledged_rules matches, or all when all of them match. Defaults to unused, and any other value requires started_alert_id_field and acknowledged_alert_id_field.
object
How to extract the alert ID from the e-mail that starts an incident, with the same keys as cause_field; later e-mails acknowledge and resolve the incident by matching it. Required when acknowledged_rule_type or resolved_rule_type isn’t unused.
object
How to extract the alert ID from an e-mail that resolves an incident, with the same keys as cause_field. Required when resolved_rule_type isn’t unused.
array
Extra values to extract when an incident is acknowledged, with the same keys as other_started_fields.
object
How to extract the alert ID from an e-mail that acknowledges an incident, with the same keys as cause_field. Required when acknowledged_rule_type isn’t unused.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_ESCALATION_POLICYCreates a new escalation policy for incident management. Escalation policies define who gets notified and in what order when incidents occur. Supports multiple step types: ‘escalation’ (notify members), ‘instructions’ (guidance text), ‘time_branching’ (route by schedule), and ‘metadata_branching’ (route by incident metadata). For escalation steps, a valid urgency_id from the Severities API is required.

Input Parameters

string
required
Name of the escalation policy
array
required
Ordered list of escalation policy steps
string
Team owning the policy (required with global API token)
integer
How many times to repeat the policy if unacknowledged
integer
Seconds to wait between policy repetitions

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_EXPLORATION
Create an exploration Creates a new exploration, including its chart, queries, and variables. POST /api/v2/explorations Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
The name of the exploration. This is also set as the chart’s name.
object
required
An object defining the chart’s type and settings. chart_type is required.
array
required
One or more query objects. Only line_chart supports multiple queries. query_type must be sql_expression (requires sql_query), tail_query (requires where_condition), or static_text (requires static_text), compatible with chart_type. query_builder, pql_expression and funnel_query are read-only and cannot be created.
string
Required if using a global API token to specify which team should own the resource.
array
An array of custom query variable objects. Default variables (time, start_time, end_time, source) are created automatically if not provided.
string
The end of the exploration’s date range. Defaults to now when omitted.
string
The start of the exploration’s date range. Defaults to now-3h when omitted.
integer
The ID of an exploration group to organize this exploration. Use 0 to remove it from a group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_EXPLORATION_ALERT
Create an exploration alert Creates a new alert for a specific exploration. POST /api/v2/explorations/{exploration_id}/alerts Requires a Telemetry API token with access to the resource.

Input Parameters

boolean
Enable SMS notifications. Only used if escalation_target is not a policy.
boolean
Enable phone call notifications. Only used if escalation_target is not a policy.
string
required
The name of the alert.
boolean
Enable push notifications. Only used if escalation_target is not a policy.
boolean
Enable e-mail notifications. Only used if escalation_target is not a policy.
number
The numeric value for the alert condition. For threshold alerts, this is the static threshold. For relative alerts, this is the percentage change. Required for threshold and relative types unless string_value is set. A value of 0 is valid.
boolean
Set to true to create the alert in a paused state.
object
A key-value object for custom metadata to be included in incidents. Both keys and values must be strings. For details, see Metadata.
string ("equal" | "not_equal" | "higher_than" | "higher_than_or_equal" | "lower_than" | "lower_than_or_equal" | "increases_by" | "decreases_by" | "changes_by")
The comparison operator. Required for threshold and relative alerts. For threshold: equal, not_equal, higher_than, higher_than_or_equal, lower_than, lower_than_or_equal. For relative: increases_by, decreases_by, changes_by. Not used for anomaly_rrcf alerts.
string ("threshold" | "relative" | "anomaly_rrcf")
required
The type of alert. threshold for static values, relative for percentage changes, and anomaly_rrcf for ML-based anomaly detection.
string ("source_variable" | "platforms_single_source" | "platforms_all_sources")
The mode for source selection. Valid values: source_variable, platforms_single_source, platforms_all_sources.
integer
How often to evaluate the alert condition, in seconds. Required for threshold and relative alert types. Not used for anomaly_rrcf alerts.
integer
The time window in seconds for the data being analyzed. If not provided, falls back to aggregation_interval, then check_period.
array
An array of strings to filter the alert to specific data series. Cannot be combined with series_names_except. Send an empty array to alert on any series.
string
An alternative to value for threshold alerts when matching an exact string. If string_value is set, value is not required. Only valid with equal or not_equal operators.
string
A custom name template for the incident created by this alert, in plain text. Supports the same variables as incident_cause, such as {{alert_name}} and {{series_name}}. When empty, the incident is named after the exploration and the alert.
boolean
Enable critical push notifications that bypass Do Not Disturb. Only used if escalation_target is not a policy.
integer
required
The unique identifier of the exploration to add the alert to.
string
A custom description template for the incident created by this alert. Supports {{value}} placeholder.
string ("any" | "higher" | "lower")
Defines which anomalies trigger an alert: any (both higher and lower), higher, or lower. Only for anomaly_rrcf alerts.
string ("treat_as_zero" | "dont_fire" | "treat_as_previous" | "start_incident")
What to do when the query returns no data: treat_as_zero, dont_fire, treat_as_previous, or start_incident. Only for threshold and relative alerts. Default: dont_fire.
integer
The duration in seconds that a condition must be resolved before an incident is recovered. A value of 0 recovers the incident immediately, null means never automatically recover an incident. Default: 60.
string
The variable name for the source selection. If not provided, derived automatically from the exploration preset’s source variable.
array
An array of platform names to filter the sources this alert runs on.
string
Defines where to send notifications. Defaults to current_team, for details see Escalation targets.
number
How far the value must deviate from its predicted value to trigger an alert, from 1 to 10. Higher values require a larger deviation and trigger fewer alerts. Shown as Significance in the app. Only for anomaly_rrcf alerts. Default: 5.
integer
The duration in seconds that a condition must be met before an alert is triggered. A value of 0 triggers the alert immediately. Default: 60.
boolean
Whether a separate incident will be created for each data series that triggers the alert.
array
An array of strings to alert on all data series except the listed ones. Cannot be combined with series_names.
integer
The size of data buckets in seconds for aggregating and evaluating the metric. If not provided, falls back to query_period, then check_period.
array
An array of up to 4 additional conditions, each combined with the primary condition using logical AND, so the alert only fires where every condition is breached in the same time bucket. Each condition is an object with an alert_type of threshold or relative, an operator, a value or string_value, and an optional series_names or series_names_except scope. Anomaly detection cannot be used as an additional condition. Send an empty array to clear all additional conditions. See Multiple conditions for an example.
integer
How many days of history the anomaly detection model is trained on, from 1 to 30. Only for anomaly_rrcf alerts. Default: 7.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_EXPLORATION_GROUP
Create an exploration group Creates a new exploration group for organizing explorations. POST /api/v2/exploration-groups Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
The name of the exploration group.
string
Required if using a global API token to specify which team should own the resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_GOOGLE_MONITORING_INTEGRATION
Create Google Monitoring integration Returns either a newly created Google Monitoring integration, or validation errors. POST /api/v2/google-monitoring-integrations Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

boolean
Send an SMS to the on-call person.
boolean
Call the on-call person.
string
The name of the Google Monitoring integration that you can see in the dashboard.
boolean
Send a push notification to the on-call person.
boolean
Send an e-mail to the on-call person.
boolean
Set to true to pause the integration, false to unpause it.
string
ID of the escalation policy associated with the Google Monitoring integration.
string
Required if using global API token to specify the team which should own the resource
integer
How long we wait before escalating the incident alert to the team. In seconds.
boolean
Send a critical push notification that ignores the mute switch and Do not Disturb mode.
integer
Has no effect for this integration, since an incident resolves as soon as Google Monitoring reports the alert as resolved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_GRAFANA_INTEGRATION
Create Grafana integration Returns either a newly created Grafana integration, or validation errors. POST /api/v2/grafana-integrations Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

boolean
Send an SMS to the on-call person.
boolean
Call the on-call person.
string
The name of the Grafana integration that you can see in the dashboard.
boolean
Send a push notification to the on-call person.
boolean
Send an e-mail to the on-call person.
boolean
Set to true to pause the integration, false to unpause it.
string
ID of the escalation policy associated with the Grafana integration.
string
Required if using global API token to specify the team which should own the resource
integer
How long we wait before escalating the incident alert to the team. In seconds.
boolean
Send a critical push notification that ignores the mute switch and Do not Disturb mode.
integer
Has no effect for this integration, since an incident resolves as soon as Grafana reports the alert as resolved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_HEARTBEATTool to create a new heartbeat monitor for cron jobs and scheduled tasks. Use when you need to set up monitoring for a service that should send regular heartbeat signals.

Input Parameters

boolean
Should we send an SMS to the on-call person?
boolean
Should we call the on-call person?
string
The name of the service for this heartbeat
boolean
Should we send a push notification to the on-call person?
boolean
Should we send an email to the on-call person?
integer
Grace period for heartbeat fluctuation in seconds. Minimum value: 0. Recommended: 20% of period
boolean
Set to true to pause monitoring
integer
How often should we expect this heartbeat in seconds. Minimum value: 30 seconds
string
Required if using global API token to specify the team which should own the resource
integer
Set this attribute to add this heartbeat to a heartbeat group

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_HEARTBEAT_GROUPTool to create a new heartbeat group. Use when you need to organize related heartbeat checks under a single, logical group. Example prompt: “Create a new heartbeat group named ‘Backend services’.”

Input Parameters

string
required
Name of the group visible in the dashboard.
boolean
Set to true to pause monitoring for all existing heartbeats in the group; false (default) to resume monitoring.
string
Team which should own the resource. Required when using a global API token.
integer
Zero-based index to control sort order of heartbeat groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_INCIDENTTool to create a new incident and alert the on-call person. Use when you need to manually report an incident or trigger escalation workflows. The incident will be routed according to the specified escalation policy or default team settings.

Input Parameters

boolean
Send SMS notification to on-call person
boolean
Trigger phone call to on-call person
string
Short incident title
boolean
Send email notification to on-call person
string
Brief incident overview
object
Custom metadata with key-value pairs for incident classification and routing
string
Escalation policy identifier for routing the incident
string
Team owning the incident (required when using global API token)
integer
Escalation delay in seconds before alerting entire team. Leave blank to disable team escalation.
string
Detailed incident information
boolean
Send critical push notification that ignores mute switch and Do Not Disturb settings
string
Email of user requesting the incident

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_INCIDENT_COMMENTTool to create a new comment on an incident. Use when you need to add documentation, updates, or notes to an existing incident in Better Stack.

Input Parameters

string
required
The content of the comment. Markdown is supported for formatting.
string
required
The ID of the incident to add the comment to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_INCOMING_WEBHOOK
Create incoming webhook Returns either a newly created incoming webhook, or validation errors. POST /api/v2/incoming-webhooks Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

boolean
Send an SMS to the on-call person.
boolean
Call the on-call person.
string
The name of the incoming webhook that you can see in the dashboard.
boolean
Send a push notification to the on-call person.
boolean
Send an e-mail to the on-call person.
boolean
Set to true to pause the integration, false to unpause it.
string
ID of the escalation policy for incidents from this integration. Without one, incidents alert the current on-call person through the channels set by call, sms, email, and push.
string
Required if using global API token to specify the team which should own the resource
integer
How long we wait before escalating the incident to the team. In seconds. Send null to never escalate to the team, or 0 to alert the whole team right away.
object
Incident cause extraction object; omitted means Unknown cause. Required string keys: field_target (query_string, header, body, json, xml) and match_type (match_everything, match_before, match_after, match_between, match_regex). target_field: dot path such as alert.id for json/query_string, header name for header, or CSS selector for xml; unused for body. match_everything takes the whole value. match_before/match_after require string content and extract text before/after it. match_regex requires a regex in content and extracts its match or capture group. match_between requires string content_before and content_after delimiters.
object
How to extract a custom incident title, as a field object with the same keys as cause_field. Send null to remove it and use the default title.
array
The conditions started_rule_type checks, as an array of rule objects with the keys below. At least one rule is required when the type is any or all. Nested fields: started_rules[].rule_target: Which part of the request the rule checks: query_string, header, body, json, or xml.; started_rules[].target_field: Which value to read: a dot-separated path such as alert.id for json and query_string, a header name for header, or a CSS selector for xml. Not used with body.; started_rules[].match_type: How to compare the value with content: contains, contains_not, equals, equals_not, matches_regex, or matches_regex_not.; started_rules[].content: The value to compare with. Must be a valid regular expression for matches_regex and matches_regex_not.
boolean
Send a critical push notification that ignores the mute switch and Do Not Disturb mode.
array
The conditions resolved_rule_type checks, as rule objects with the same keys as started_rules.
integer ("0" | "60" | "180" | "300" | "900" | "1800" | "3600" | "7200")
How long to wait after a request matching resolved_rules arrives before marking an incident as resolved, in seconds: 0, 60, 180, 300, 900, 1800, 3600, or 7200. Has no effect while resolved_rule_type is unused.
string ("unused" | "any" | "all")
When requests start an incident: unused always, any when at least one of started_rules matches, or all when all of them match. Defaults to unused.
array
The conditions acknowledged_rule_type checks, as rule objects with the same keys as started_rules.
string ("unused" | "any" | "all")
When requests resolve an incident: unused never, any when at least one of resolved_rules matches, or all when all of them match. Defaults to unused, and any other value requires started_alert_id_field and resolved_alert_id_field.
array
Extra values to extract when an incident starts, saved as incident metadata. Each field object has the same keys as cause_field, plus name. Nested fields: other_started_fields[].name: The metadata key to save the extracted value under. Must be unique within the array.
array
Extra values to extract when an incident is resolved, with the same keys as other_started_fields.
string ("unused" | "any" | "all")
When requests acknowledge an incident: unused never, any when at least one of acknowledged_rules matches, or all when all of them match. Defaults to unused, and any other value requires started_alert_id_field and acknowledged_alert_id_field.
object
How to extract the alert ID from the request that starts an incident, with the same keys as cause_field; later requests acknowledge and resolve the incident by matching it. Required when acknowledged_rule_type or resolved_rule_type isn’t unused.
object
How to extract the alert ID from a request that resolves an incident, with the same keys as cause_field. Required when resolved_rule_type isn’t unused.
array
Extra values to extract when an incident is acknowledged, with the same keys as other_started_fields.
object
How to extract the alert ID from a request that acknowledges an incident, with the same keys as cause_field. Required when acknowledged_rule_type isn’t unused.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_METADATATool to create or update a metadata record for a resource. Metadata provides key-value associations for resources like monitors, heartbeats, or incidents. Use when you need to tag or annotate resources with custom data. Existing values for the specified key will be completely replaced.

Input Parameters

string
required
The metadata key identifier. This serves as the name for the metadata entry
array
required
Array of metadata values to associate with the key. Existing values for the given key will be completely replaced
string
required
The ID of the resource to update metadata for
string ("Monitor" | "Heartbeat" | "Incident" | "WebhookIntegration" | "EmailIntegration" | "IncomingWebhook" | "CallRouting")
required
Type of resource that owns this metadata. Must be one of: Monitor, Heartbeat, Incident, WebhookIntegration, EmailIntegration, IncomingWebhook, or CallRouting

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_METRIC
Create a metric Returns a newly created metric or label. POST /api/v2/sources/{source_id}/metrics Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
Metric name
integer
required
Source for which to create a metric
string
Required if using global API token to specify the team which should own the resource
array
Aggregations to apply to the metric. Omit or send an empty array to create a label instead. Valid aggregations are avg, count, uniq, max, min, sum, and histogram.
string
required
SQL expression to use for the metric

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_MONITORTool to create a new uptime monitor for a URL or service. Use when you need to set up monitoring for websites, APIs, servers, or network services. Supports multiple monitor types including HTTP/HTTPS status checks, keyword monitoring, ping, TCP/UDP, email protocols, DNS queries, and browser automation with Playwright.

Input Parameters

boolean
Enable SMS notifications when monitor goes down or recovers. Default is false.
string
required
The URL or host to monitor. For HTTP/HTTPS monitors use full URL with protocol. For TCP/UDP/SMTP/POP/IMAP use hostname or IP. For DNS monitors use the domain to query.
boolean
Enable phone call alerts when monitor goes down or recovers. Default is false.
string
Port number for TCP, UDP, SMTP, POP, or IMAP monitors. Required for these monitor types.
boolean
Enable push notifications when monitor goes down or recovers. Default is false.
boolean
Enable email notifications when monitor goes down or recovers. Default is false.
boolean
If true, the monitor is created in paused state and will not perform checks. Default is false.
array
List of regions from which to perform checks. Available: us (United States), eu (Europe), as (Asia), au (Australia). Default is all regions.
string
ID of the escalation policy to use for this monitor. Controls who gets notified and in what order.
string
Team which should own this monitor. Required when using a global API token.
integer
Seconds to wait before escalating to the team after first notification. Default is 0 (notify team immediately).
boolean
Verify SSL certificates for HTTPS monitors. If false, monitors will accept invalid/self-signed certificates. Default is true.
string ("GET" | "HEAD" | "POST" | "PUT" | "PATCH")
HTTP method for status/keyword monitors.
string ("status" | "expected_status_code" | "keyword" | "keyword_absence" | "ping" | "tcp" | "udp" | "smtp" | "pop" | "imap" | "dns" | "playwright")
required
Type of monitor: status (HTTP/HTTPS), expected_status_code, keyword, keyword_absence, ping (ICMP), tcp, udp, smtp, pop, imap, dns, or playwright (browser automation).
string
Body content to send with POST/PUT/PATCH requests. Required for DNS monitors (specify the DNS record type to query).
string
Password for HTTP Basic Authentication. Used with auth_username.
string
Username for HTTP Basic Authentication. Used with auth_password.
string
Name identifier for playwright monitor scenarios. Used to distinguish between different automation scripts.
boolean
If enabled, alerts will override Do Not Disturb settings and mute schedules. Use for critical monitors only.
string
End time of daily maintenance window in HH:MM:SS format. Checks resume after this time.
integer
How often to check the monitor in seconds. Minimum is 30 seconds. Default is 30.
integer
Number of seconds the monitor must be up before automatically resolving any open incidents. Default is 0 (resolve immediately).
integer
Request timeout in seconds. For server monitors this is in milliseconds. Default varies by monitor type.
boolean
Automatically follow HTTP redirects when checking status/keyword monitors. Default is false.
array
Days of the week to skip monitoring checks during maintenance windows. Combine with maintenance_from and maintenance_to.
string
Start time of daily maintenance window in HH:MM:SS format. Checks are skipped during this window on specified maintenance_days.
string
ID of the monitor group to assign this monitor to. Used for organizing monitors.
string
For keyword monitors: the text that must be present in the response. For keyword_absence monitors: the text that must NOT be present.
string
JavaScript code for playwright monitor type. Defines browser automation scenario to execute during checks.
string
required
Human-readable name for the monitor displayed in the dashboard.
integer
How long in seconds to observe failures before creating an incident. Helps avoid false alerts from transient issues. Default is 0.
integer
ID of the escalation policy for SSL certificate and domain expiration alerts.
string
Timezone for maintenance window times. Use IANA timezone database names.
object
Key-value pairs of environment variables accessible within playwright scripts. Useful for parameterizing automation scenarios.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_MONITOR_GROUPTool to create a new monitor group. Use when you need to organize related monitors under a single, logical group for better dashboard organization.

Input Parameters

string
required
The display name for the monitor group visible in the dashboard
boolean
When true, monitoring pauses for existing group monitors; false resumes monitoring
string
Required only when using a global API token to specify resource ownership
integer
Numeric value controlling monitor group sort order

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_NEW_RELIC_INTEGRATION
Create New Relic integration Returns either a newly created New Relic integration, or validation errors. POST /api/v2/new-relic-integrations Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

boolean
Send an SMS to the on-call person.
boolean
Call the on-call person.
string
The name of the New Relic integration that you can see in the dashboard.
boolean
Send a push notification to the on-call person.
boolean
Send an e-mail to the on-call person.
boolean
Set to true to pause the integration, false to unpause it.
string
ID of the escalation policy associated with the New Relic integration.
string
Required if using global API token to specify the team which should own the resource
integer
How long we wait before escalating the incident alert to the team. In seconds.
string ("alert" | "alert_and_warn")
Should we alert only on alarms, or on both alarms and warnings. Possible values: alert, alert_and_warn. Defaults to alert.
boolean
Send a critical push notification that ignores the mute switch and Do not Disturb mode.
integer
Has no effect for this integration, since an incident resolves as soon as New Relic reports the alert as resolved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_ON_CALL_EVENT
Create an on-call schedule event Create a new event in the given on-call schedule. POST /api/v2/on-calls/{schedule_id}/events Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

array
required
List of e-mail addresses of users that will be on-call during this event. Each user must be a member of the schedule’s team with a role that can respond to incidents, such as Responder.
string
required
End time of the event as an ISO 8601 date-time.
boolean
Whether this event is an override. Override events take precedence over regular scheduled events. Defaults to false.
string
required
Start time of the event as an ISO 8601 date-time. Must be today at 0:00 UTC or later.
string
required
The ID of the on-call schedule you want to create the event for. Use default to refer to the default on-call schedule for the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_ON_CALL_SCHEDULETool to create a new on-call schedule. Use when you need to set up a new on-call calendar for managing team rotations.

Input Parameters

string
required
The identifier for the on-call schedule
string
Team which should own the resource. Required when using a global API token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_OUTGOING_EMAIL
Create outgoing e-mail Returns either a newly created outgoing e-mail integration, or validation errors. See the outgoing e-mails guide for the dashboard walkthrough. POST /api/v2/outgoing-emails Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
The name of the outgoing e-mail integration that you can see in the dashboard.
string
Required if using a global API token to specify the team which should own the resource.
array
Per-event template objects with incident_stage (started, acknowledged, resolved, reopened, comment) and optional subject, title, body strings. Empty fields use default copy. Supports $NAME, $STATUS, $CAUSE, $INCIDENT_URL, $RECIPIENT.<key>, $METADATA.Key and $METADATA_ARRAY. Example: [{“incident_stage”:“started”,“subject”:“Incident: $NAME”}]. Included stages are created/updated; omitted stages are removed. Omit templates entirely to leave existing templates untouched.
array
required
The addresses that receive incident e-mails. At least one recipient is required. Each entry is either a plain e-mail string, or an object with an email key plus your own custom attribute keys, which you can insert into templates with $RECIPIENT.<key>. json [label Plain strings and objects can be mixed] { "recipients": [ "noc@client.com", { "email": "ops@client.com", "first_name": "Sam", "team": "SRE" } ] }
boolean
Whether to send an e-mail when a new comment is added to an incident. Defaults to true. At least one of the on_incident_* triggers must be enabled.
boolean
Whether to send an e-mail when an incident starts. Defaults to true.
boolean
Whether to send an e-mail when an incident is reopened. Defaults to true.
boolean
Whether to send an e-mail when an incident is resolved. Defaults to true.
boolean
Whether to send an e-mail when an incident is acknowledged. Defaults to true.
boolean
Whether to notify recipients alongside the primary responder when no escalation policy is configured. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_OUTGOING_WEBHOOKTool to create a new outgoing webhook integration. Use when you need to register an endpoint to receive event notifications from Better Stack.

Input Parameters

string
required
The endpoint URL of the outgoing webhook integration.
string
required
The name of the outgoing webhook integration.
string
Required if using a global API token to specify the team which should own the resource.
string ("on_call_change" | "incident_change" | "monitor_change")
required
The type of event that triggers the webhook.
boolean
Trigger when an incident starts (only if trigger_type is ‘incident_change’).
boolean
Trigger when an incident is resolved (only if trigger_type is ‘incident_change’).
boolean
Trigger when an incident is acknowledged (only if trigger_type is ‘incident_change’).
object
Custom webhook template attributes such as HTTP method, headers, and body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_PAGERDUTY_INTEGRATION
Create PagerDuty integration Returns either a newly created PagerDuty integration, or validation errors. POST /api/v2/pager-duty-webhooks Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The PagerDuty routing key.
string
required
The name of the PagerDuty integration that you can see in the dashboard.
string ("info" | "warning" | "error" | "critical")
required
The severity of PagerDuty alerts created for new incidents.
string
Required if using global API token to specify the team which should own the resource
boolean
Whether to notify this integration alongside the primary responder when no escalation policy is configured. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_POLICY_GROUPTool to create a new escalation policy group. Use when you need to organize related escalation policies under a single logical group.

Input Parameters

string
required
The name of the group that you can see in the dashboard
string
Required only when using a global API token to designate the owning team
integer
Specifies the ordering sequence for escalation policy groups

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_PROMETHEUS_INTEGRATION
Create Prometheus integration Returns either a newly created Prometheus integration, or validation errors. POST /api/v2/prometheus-integrations Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

boolean
Send an SMS to the on-call person.
boolean
Call the on-call person.
string
The name of the Prometheus integration that you can see in the dashboard.
boolean
Send a push notification to the on-call person.
boolean
Send an e-mail to the on-call person.
boolean
Set to true to pause the integration, false to unpause it.
string
ID of the escalation policy associated with the Prometheus integration.
string
Required if using global API token to specify the team which should own the resource
integer
How long we wait before escalating the incident alert to the team. In seconds.
boolean
Send a critical push notification that ignores the mute switch and Do not Disturb mode.
integer
Has no effect for this integration, since an incident resolves as soon as Prometheus reports the alert as resolved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_SCHEDULE_ROTATION
Create an on-call schedule rotation Creates an on-call rotation. This creates consecutive on-call events for specified users, rotating through them until reaching the end date, and removes any existing non-override events within this range. Without working_hours, this only creates events that end after 0:00 UTC today. With working_hours, it creates events from now on, only inside the given windows. POST /api/v2/on-calls/{schedule_id}/rotation Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

array
required
List of e-mail addresses of users to include in the on-call rotation schedule
string
Time zone the rotation’s start time and working hours are interpreted in, for example Europe/Prague. Omit it and the rotation keeps the time zone it already had. Only a rotation that has never had one falls back to UTC.
string
Required if using global API token to specify the team which should own the resource.
string
required
The ID of the on-call schedule you want to create the event for. Use default to refer to the default on-call schedule for the team.
array
List of windows during which the rotation pages anyone, one object per day and window with day, start_time and end_time. day is one of sunday, monday, tuesday, wednesday, thursday, friday, saturday. Times are HH:MM on a 24-hour clock. An end_time that is not after start_time runs overnight, so 00:00 to 00:00 is the whole day. Several windows on one day are allowed. Omit the parameter for a rotation that is active around the clock. Omitting it on a rotation that has working hours removes them. See example below.
integer
required
The length of the specified rotation period, must be an integer
string
required
End time of the rotations
string ("hour" | "day" | "week")
required
The rotation interval, must be one of: hour, day, week
string
required
Start time of the rotations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_SOURCE
Create a source Returns a newly created source. POST /api/v2/sources Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
Source name
string ("apache2" | "aws" | "aws_cloudwatch" | "aws_ecs" | "aws_elb" | "aws_fargate" | "azure" | "azure_logs" | "claude_platform" | "cloudflare_logpush" | "cloudflare_prometheus_exporter" | "cloudflare_worker" | "datadog_agent" | "digitalocean" | "docker" | "dokku" | "dotnet" | "elasticsearch" | "erlang" | "fastly" | "filebeat" | "flights" | "fluentbit" | "fluentd" | "fly_io" | "go" | "gcp" | "google_cloud_pubsub" | "haproxy" | "heroku" | "http" | "java" | "javascript" | "kubernetes" | "logstash" | "minio" | "mongodb" | "mysql" | "nginx" | "open_telemetry" | "php" | "postgresql" | "prometheus" | "prometheus_scrape" | "python" | "rabbitmq" | "redis" | "render" | "rsyslog" | "ruby" | "syslog-ng" | "traefik" | "ubuntu" | "vector" | "vercel_integration" | "winlogbeat")
required
Source platform, one of: apache2, aws, aws_cloudwatch, aws_ecs, aws_elb, aws_fargate, azure, azure_logs, claude_platform, cloudflare_logpush, cloudflare_prometheus_exporter, cloudflare_worker, datadog_agent, digitalocean, docker, dokku, dotnet, elasticsearch, erlang, fastly, filebeat, flights, fluentbit, fluentd, fly_io, go, gcp, google_cloud_pubsub, haproxy, heroku, http, java, javascript, kubernetes, logstash, minio, mongodb, mysql, nginx, open_telemetry, php, postgresql, prometheus, prometheus_scrape, python, rabbitmq, redis, render, rsyslog, ruby, syslog-ng, traefik, ubuntu, vector, vercel_integration, winlogbeat.
string
Required if using global API token to specify the team which should own the resource
string
Data region or private cluster name to create the source in. Permitted values for most plans are: us_east, germany, singapore.
array
URLs to scrape by prometheus_scrape platform and similar.
object
Custom S3-compatible storage configuration: name (bucket name), endpoint (full bucket URL), access_key_id, secret_access_key, and keep_data_after_retention (boolean).
integer
Data retention for logs in days. There might be additional charges for longer retention.
array
Metric names to mark as spam. Listed metrics are rejected during ingestion and aren’t billed.
boolean
Whether to skip SSL/TLS certificate verification for prometheus_scrape platform and similar. Set to true to disable verification.
integer
The ID of the source group this source belongs to
boolean
Enable or disable ingesting for this source
string
Live tail message format with columns wrapped in {column} brackets. Example: "PID: {message_json.pid} {level} {message}". For details, see Live tail docs.
integer
Data retention for metrics in days. There might be additional charges for longer retention.
integer
How often to scrape the URLs for prometheus_scrape platform and similar. Permitted values are 15, 30, 60, 120 or 300.
array
An array of request headers for prometheus_scrape platform and similar, with each object containing name and value fields.
string
The VRL code applied to logs during ingestion. Read more about VRL transformations.
string
The VRL code applied to traces (spans) during ingestion. Read more about VRL transformations.
string
Basic auth username for prometheus_scrape platform and similar.
string
Basic auth password for prometheus_scrape platform and similar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_SOURCE_GROUPTool to create a new source group. Use when you have finalized the group name (and optional sort index) and need to organize related log sources under that group.

Input Parameters

string
required
The name of the group that you can see in the dashboard.
string
Required if using a global API token to specify the team which should own the resource.
integer
Set sort_index to specify how to sort your source groups. Must be non-negative.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_SPLUNK_INTEGRATION
Create a Splunk integration Returns either a newly created Splunk On-Call integration, or validation errors. POST /api/v2/splunk-on-calls Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The Splunk On-Call URL to which to post webhooks to.
string
The name of the Splunk On-Call integration that you can see in the dashboard.
string
Required if using global API token to specify the team which should own the resource
boolean
Whether to notify this integration alongside the primary responder when no escalation policy is configured. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_STATUS_PAGE
Create status page Returns a newly created status page or validation errors. POST /api/v2/status-pages Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string ("light" | "dark" | "system")
Color theme of your status page. Possible values: light, dark, system. Defaults to light. This only applies when the design is set to v2.
string ("v1" | "v2")
Classic or modern status page design. Possible values: v1, v2. Defaults to v1.
string ("vertical" | "horizontal")
Header layout of your status page. Possible values: vertical, horizontal. Defaults to vertical. This only applies when the design is set to v2.
integer
Number of days of history to display on the status page. Between 7 and 365, defaults to 90.
string
A direct link to your company’s logo, including the https:// scheme. We download the image from it, and it must be under 20MB in size.
string
Password for your status page, stored encrypted. Required when password_enabled is true. Sending a password turns protection on unless you also send password_enabled, and sending an empty password turns it off.
string
required
Timezone to display your status page in, for example Tokyo or Europe/Prague. Accepts IANA time zone IDs and the names in the Rails TimeZone documentation
boolean
Whether the status page is published and accessible. Defaults to true.
string
required
Subdomain of your status page. It must be unique across Better Stack, up to 63 characters of letters, digits, dashes and underscores.
string
Team that should own the status page when using a global API token. Omit for a team-scoped token.
string
Unleash your inner designer and tweak our status page design to fit your branding
string
URL of your company’s website
string
URL visitors can use to contact you in an emergency, for example https://example.com/support or mailto:support@example.com. Can be null.
boolean
Require SSO sign-in to access your status page. Requires SSO to be configured for your organization and is mutually exclusive with password protection. Defaults to false.
string
An announcement to show on your status page. Can be null.
string
required
Name of your company, displayed on the status page.
array
Restrict access to your status page by IP address. Only visitors from specified IP addresses or CIDR ranges can view the status page. Entries starting with # are comments. This is a billable feature
boolean
Whether visitors can subscribe to updates of your status page. Defaults to false.
boolean
Whether to remove the ‘Powered by Better Stack’ footer. Defaults to false. This is a billable feature
string
A host name you own to serve the status page from, for example status.walmine.com. Add a CNAME record pointing it to statuspage.betteruptime.com. Can be null.
string
A direct link to a dark version of your company’s logo, including the https:// scheme. We download the image from it, and it must be under 20MB in size.
Adjust the navigation links on your status page. Accepts an array of objects containing keys text and href: • text is the navigation link label. • href is the link. Use a full URL for external links. Use /, /maintenance and /incidents for built-in links. At most 4 links are allowed. This only applies when the design is set to v2.
boolean
Whether to protect your status page with a password. Defaults to false.
boolean
Whether to automatically create status page updates for new incidents. Defaults to false.
string
Level up your status page by adding analytics, interactive features, or any other functionality you need
string
Your own Google Analytics ID to track visits to your status page, for example G-XXXXXXXX. Must start with G-, UA- or GTM-.
integer
Hide incidents shorter than this many seconds from the status page. Defaults to 0, which shows all incidents. Must be shorter than one year.
integer
The ID of the status page group to which this status page will belong. Can be null.
string
Custom CSS for the announcement embed.
URL the announcement embed links to. Defaults to your status page.
boolean
Whether to hide your status page from search engines. Defaults to false.
boolean
Whether to show the announcement in the announcement embed. Defaults to true. Embed it on your website with <script src="https://uptime.betterstack.com/widgets/announcement.js" data-id="YOUR_STATUS_PAGE_ID" async="async" type="text/javascript"></script>.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_STATUS_PAGE_GROUPTool to create a new status page group. Use when you need to organize related status pages under a single logical group with a descriptive name.

Input Parameters

string
required
A descriptive label for the group visible in the dashboard.
string
Required only when using a global API token to designate which team owns the resource.
integer
Numeric value controlling the sort order of status page groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_STATUS_PAGE_REPORTTool to create a new status page report (incident or maintenance). Use when you need to publish a status update about an ongoing incident or scheduled maintenance on a status page.

Input Parameters

string
required
The title/name for the status page report
string
ISO-8601 timestamp when the report/incident ends. Leave empty for ongoing incidents.
string
required
The initial status update text/message for this report
string
ISO-8601 timestamp when the report/incident starts. If not provided, defaults to current time.
string ("manual" | "maintenance")
Type of report: ‘manual’ for incident reports or ‘maintenance’ for scheduled maintenance. Defaults to ‘manual’.
string
ISO-8601 timestamp when the report should be published. If not provided, the report is published immediately.
string
required
The numeric ID of the status page (e.g., ‘221582’). Obtain this from the list_status_pages action.
array
required
List of status page resources affected by this report, with their status. Each object must contain status_page_resource_id and status fields. For maintenance reports, use status=‘maintenance’. For manual incident reports, use status=‘resolved’, ‘degraded’, or ‘downtime’.
boolean
Whether to send email notifications to status page subscribers. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_STATUS_PAGE_RESOURCETool to create a new status page resource. Use when you need to add a monitor, heartbeat, or other resource to a status page for public visibility tracking.

Input Parameters

integer
Zero-indexed placement position on the status page (omit to append to end)
string
Detailed help text displayed as an icon tooltip
string
Display name shown publicly on the status page
string
required
The identifier of the resource being added (Monitor, Heartbeat, etc.)
string ("plain" | "history" | "response_times" | "chart_only")
Display format for the resource on the status page
string ("Monitor" | "MonitorGroup" | "Heartbeat" | "HeartbeatGroup" | "WebhookIntegration" | "EmailIntegration" | "IncomingWebhook" | "ResourceGroup" | "LogsChart" | "CatalogReference")
required
Type of resource to add to the status page
boolean
Prevents position reordering when true
string
required
The ID of the status page to add the resource to
string ("any_incident" | "no_incident" | "incident_matching_metadata")
Condition that triggers marking the resource as down
string ("any_incident" | "no_incident" | "incident_matching_metadata")
Condition that triggers marking the resource as degraded
integer
Section ID where the resource should be placed (defaults to first section if omitted)
object
Metadata rule for status matching.
object
Metadata rule for status matching.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_STATUS_PAGE_SECTIONTool to create a new section on a status page. Use when organizing resources into logical groups (e.g., by datacenter or service type). Leave name blank to hide the section header.

Input Parameters

string
The name of the section. Leave blank to hide the section header.
integer
The position of this section on your status page, indexed from zero. Defaults to the end if not specified.
string
required
The identifier for your status page where the section will be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_STATUS_PAGE_SUBSCRIBER
Create status page subscriber Creates a confirmed e-mail subscriber for a status page. Creating a subscriber who previously unsubscribed subscribes that e-mail again. Creating an e-mail address that is already actively subscribed returns 422. POST /api/v2/status-pages/{status_page_id}/subscribers Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The subscriber e-mail address.
string
required
The ID of your status page.
array
The status page resources this subscriber receives updates for. Use [] for all resources. Each ID must be a resource of this status page other than a third party service. Get valid resource IDs from GET /api/v2/status-pages/{status_page_id}/resources.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_STATUS_UPDATETool to create a new status update for an existing status report. Use when you need to post an update about the current state of an incident or maintenance. The update can include a message, affected resources with their status, and optionally notify subscribers.

Input Parameters

string
Message associated with the status update, providing details about the current state or actions taken.
string
ISO-8601 timestamp for publication time. If not provided, defaults to current time.
string
required
Your status page identifier. Obtain from list_status_pages action.
string
required
Your status page report identifier. Obtain from list_status_page_reports action.
array
required
Array of affected resources with their current status. Must contain at least one resource.
boolean
Send notification email to subscribers. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_URGENCIESTool to create a new severity level (urgency) for incident management. Use when you need to define notification preferences for different incident severity levels.

Input Parameters

boolean
required
Enables SMS notifications for new incidents at this severity level
boolean
required
Enables phone calls for new incidents at this severity level
string
required
The identifier for this severity level
boolean
required
Enables push notifications for new incidents at this severity level
boolean
required
Enables email notifications for new incidents at this severity level
string
Required only when using global API tokens to designate resource ownership
boolean
Sends critical alerts bypassing device mute settings

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_CREATE_URGENCY_GROUPTool to create a new urgency group (severity group) for incident categorization. Use when you need to define severity levels for monitoring alerts and incidents.

Input Parameters

string
required
The name of the urgency group that you can see in the dashboard.
string
Required only when using a global API token to specify resource ownership. The team which should own the urgency group.
integer
Determines the ordering of severity groups. Must be non-negative.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_ALERT
Remove an alert Permanently deletes an alert by its ID. DELETE /api/v2/alerts/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the alert to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_AMAZON_SNS_INTEGRATIONPermanently delete an Amazon SNS integration from Better Stack. Stops accepting topic notifications but leaves the AWS SNS subscription intact; remove that subscription separately in AWS. Returns no content on success. Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Amazon SNS integration you want to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_AWS_CLOUDWATCH_INTEGRATION
Remove AWS CloudWatch integration Permanently deletes an existing AWS CloudWatch integration. DELETE /api/v2/aws-cloudwatch-integrations/{aws_cloudwatch_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the AWS CloudWatch integration you want to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_AWS_LOG_GROUP_SUBSCRIPTIONDelete a log group subscription override and restore automatic behavior. The log group follows the source’s auto-subscribe setting afterward; deleting an override does not necessarily unsubscribe the log group. Requires an aws source with a connected AWS account and a Telemetry API token with access to the resource. Returns an empty response on success (HTTP 204).

Input Parameters

string
required
ID of the log group subscription override
string
required
ID of the aws source

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_AZURE_INTEGRATION
Remove Azure integration Permanently deletes an existing Azure integration. DELETE /api/v2/azure-integrations/{azure_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Azure integration you want to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_CATALOG_ATTRIBUTE
Remove catalog attribute Permanently deletes an existing Catalog attribute. DELETE /api/v2/catalog/relations/{relation_id}/attributes/{attribute_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Catalog relation you want to delete an attribute for.
string
required
The ID of the Catalog attribute you want to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_CATALOG_RECORD
Remove catalog record Permanently deletes an existing Catalog record. DELETE /api/v2/catalog/relations/{relation_id}/records/{record_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Catalog record you want to delete.
string
required
The ID of the Catalog relation you want to delete a record for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_CATALOG_RELATION
Remove catalog relation Permanently deletes an existing Catalog relation. DELETE /api/v2/catalog/relations/{relation_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Catalog relation you want to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_CHART
Remove a chart Permanently deletes a chart from a dashboard. DELETE /api/v2/dashboards/{dashboard_id}/charts/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the chart to delete.
integer
required
The unique identifier of the dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_CHART_COMMENTPermanently remove a chart comment. Success returns no content. Requires a Telemetry API token with access to the resource. Team API tokens can remove only comments with api_authored=true. With an OAuth token, the member’s own comments can also be removed. Other members’ comments and incident comments synced from Incidents return 403.

Input Parameters

integer
required
The unique identifier of the comment to remove.
integer
required
The unique identifier of the chart.
integer
required
The unique identifier of the dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_COLLECTOR
Remove a collector Permanently deletes a collector. This action is irreversible and will also remove all associated configurations and stop data collection. The underlying sources and their data will be deleted asynchronously. DELETE /api/v1/collectors/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
The unique identifier of the collector to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_COLLECTOR_METRIC_TARGET
Remove a collector metric target Permanently removes a collector target. The collector will stop monitoring this target on its next configuration sync. DELETE /api/v1/collectors/{collector_id}/targets/{target_id} Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
Identifier of the target.
string
required
Identifier of the collector.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_CONNECTIONDelete an existing ClickHouse connection by its ID. Requires a global API token; team-specific tokens are not supported. Returns no content on success, or 404 when the connection does not exist.

Input Parameters

string
required
The ID of the connection to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_DASHBOARD
Remove a dashboard Permanently deletes an existing dashboard. DELETE /api/v2/dashboards/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
The unique identifier of the dashboard to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_DASHBOARD_ALERT
Remove a dashboard alert Permanently deletes an alert from a dashboard chart. DELETE /api/v2/dashboards/{dashboard_id}/charts/{chart_id}/alerts/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the alert to delete.
integer
required
The unique identifier of the chart.
integer
required
The unique identifier of the dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_DASHBOARD_GROUP
Remove a dashboard group Permanently deletes a dashboard group by its ID. [info] Deleting a group does not delete the dashboards within it. Those dashboards will become ungrouped. [/info] DELETE /api/v2/dashboard-groups/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the dashboard group to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_DASHBOARD_SECTION
Remove a dashboard section Permanently deletes a section from a dashboard. DELETE /api/v2/dashboards/{dashboard_id}/sections/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the section to delete.
integer
required
The unique identifier of the dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_DATADOG_INTEGRATION
Remove Datadog integration Permanently deletes an existing Datadog integration. DELETE /api/v2/datadog-integrations/{datadog_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Datadog integration you want to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_ELASTIC_INTEGRATION
Remove Elastic integration Permanently deletes an existing Elastic integration. DELETE /api/v2/elastic-integrations/{elastic_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Elastic integration you want to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_EMAIL_INTEGRATION
Remove e-mail integration Permanently deletes an existing e-mail integration. DELETE /api/v2/email-integrations/{email_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the e-mail integration you want to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_ESCALATION_POLICYTool to delete an escalation policy by ID. Use when you need to permanently remove an existing escalation policy after confirming its ID.

Input Parameters

integer
required
The ID of the escalation policy you want to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_EXPLORATION
Remove an exploration Permanently deletes an exploration by its ID. [warning] Deleting an exploration also permanently deletes its associated chart, queries, and any configured alerts. This action cannot be undone. [/warning] DELETE /api/v2/explorations/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the exploration to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_EXPLORATION_ALERT
Remove an exploration alert Permanently deletes an alert by its ID. DELETE /api/v2/explorations/{exploration_id}/alerts/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the alert to delete.
integer
required
The unique identifier of the exploration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_EXPLORATION_GROUP
Remove an exploration group Permanently deletes an exploration group by its ID. [info] Deleting a group does not delete the explorations within it. Those explorations will become ungrouped. [/info] DELETE /api/v2/exploration-groups/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the exploration group to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_GOOGLE_MONITORING_INTEGRATION
Remove Google Monitoring integration Permanently deletes an existing Google Monitoring integration. DELETE /api/v2/google-monitoring-integrations/{google_monitoring_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Google Monitoring integration you want to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_GRAFANA_INTEGRATION
Remove Grafana integration Permanently deletes an existing Grafana integration. DELETE /api/v2/grafana-integrations/{grafana_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Grafana integration you want to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_HEARTBEATTool to permanently delete a heartbeat by ID. Use when you need to remove a heartbeat that is no longer needed.

Input Parameters

string
required
The unique ID of the heartbeat to delete. You can get this from the list heartbeats or get heartbeat actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_HEARTBEAT_GROUPTool to permanently delete a heartbeat group by ID. Use when you need to remove a heartbeat group that is no longer needed.

Input Parameters

string
required
The ID of the heartbeat group to delete. Use list heartbeat groups to find available IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_INCIDENTTool to permanently delete an existing incident by ID. Use when you need to remove an incident from Better Stack Uptime.

Input Parameters

string
required
The ID of the incident you want to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_INCIDENT_COMMENTTool to delete an existing comment from an incident. Use when you need to remove a comment that was previously added via the API. Note: Only comments created via the API can be deleted; comments created in the UI cannot be deleted via the API.

Input Parameters

string
required
The unique ID of the comment to delete. Note: Only API-created comments can be deleted.
string
required
The unique ID of the incident containing the comment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_INCOMING_WEBHOOK
Remove incoming webhook Permanently deletes an existing incoming webhook. DELETE /api/v2/incoming-webhooks/{incoming_webhook_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the incoming webhook you want to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_METRIC
Remove a metric Permanently deletes an existing metric or label. DELETE /api/v2/sources/{source_id}/metrics/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
ID of the metric you want to delete
integer
required
Source for which to delete a metric

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_MONITORTool to permanently delete a monitor by ID from Better Stack Uptime. Use when you need to remove a monitor that is no longer needed.

Input Parameters

string
required
The unique ID of the monitor to delete. You can get this from the list monitors or get monitor actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_MONITOR_GROUPTool to permanently delete a monitor group by ID from Better Stack Uptime. Use when you need to remove a monitor group that is no longer needed.

Input Parameters

string
required
The unique ID of the monitor group to permanently delete. You can get this from list monitor groups or create monitor group actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_NEW_RELIC_INTEGRATION
Remove New Relic integration Permanently deletes an existing New Relic integration. DELETE /api/v2/new-relic-integrations/{new_relic_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the New Relic integration you want to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_ON_CALL_EVENT
Remove on-call schedule event Delete a single event from an on-call schedule. Events starting sooner than today at 0:00 UTC can’t be deleted. DELETE /api/v2/on-calls/{schedule_id}/events/{event_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the event to delete.
string
required
The ID of the on-call schedule containing the event to delete. Use default to refer to the default on-call schedule for the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_ON_CALL_SCHEDULETool to permanently delete an on-call schedule by ID. Use when you need to remove an on-call calendar that is no longer needed.

Input Parameters

string
required
The unique ID of the on-call schedule to delete. You can get this from the list on-call schedules action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_OUTGOING_EMAIL
Remove outgoing e-mail Permanently deletes an outgoing e-mail integration. Returns an empty body with status 204 No Content on success. DELETE /api/v2/outgoing-emails/{integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the outgoing e-mail integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_OUTGOING_WEBHOOKTool to delete an outgoing webhook integration by ID. Use when you need to permanently remove an existing webhook integration.

Input Parameters

string
required
The unique ID of the outgoing webhook integration to delete. You can get this from the list or create outgoing webhook actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_PAGERDUTY_INTEGRATION
Remove PagerDuty integration Permanently deletes an existing PagerDuty integration. DELETE /api/v2/pager-duty-webhooks/{pager_duty_webhook_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the PagerDuty integration you want to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_POLICY_GROUPTool to delete an escalation policy group by ID. Use when you need to permanently remove an existing escalation policy group after confirming its ID.

Input Parameters

integer
required
The ID of the escalation policy group you want to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_PROMETHEUS_INTEGRATION
Remove Prometheus integration Permanently deletes an existing Prometheus integration. DELETE /api/v2/prometheus-integrations/{prometheus_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Prometheus integration you want to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_SCHEDULE_ROTATION
Remove an on-call schedule rotation Remove an on-call rotation for a single schedule. This also removes all on-call events generated for this on-call rotation that end after 0:00 UTC today. DELETE /api/v2/on-calls/{schedule_id}/rotation Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
Required if using global API token to specify the team which should own the resource.
string
required
The ID of the on-call schedule whose rotation should be removed. Use default to refer to the default on-call schedule for the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_SOURCE
Remove a source Permanently deletes an existing source. DELETE /api/v2/sources/{source_id} Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
Identifier of the source.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_SOURCE_GROUPTool to permanently delete a source group by ID from Better Stack Telemetry (Logs). Source groups are used to organize related log sources. Use this action when you need to remove a source group that is no longer needed. Note: This action requires a Telemetry API token (not an Uptime API token). Deleting a source group does not delete the sources within it - they will become ungrouped.

Input Parameters

string
required
The unique ID of the source group to delete. You can get this from the list source groups or create source group actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_SPLUNK_INTEGRATION
Remove Splunk integration Permanently deletes an existing Splunk On-Call integration. DELETE /api/v2/splunk-on-calls/{splunk_on_call_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Splunk On-Call integration you want to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_STATUS_PAGE
Remove status page Permanently deletes an existing status page. DELETE /api/v2/status-pages/{status_page_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the status page you want to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_STATUS_PAGE_GROUPTool to delete a status page group by ID. Use when you need to permanently remove an existing status page group.

Input Parameters

string
required
The ID of the status page group you want to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_STATUS_PAGE_REPORTTool to permanently delete a status page report by ID from Better Stack Uptime. Use this action when you need to remove an existing status page report that is no longer needed. The report will be permanently deleted and cannot be recovered.

Input Parameters

string
required
The numeric ID of the status report to delete (e.g., ‘824278’). Obtain this from the list_status_page_reports action.
string
required
The numeric ID of the status page (e.g., ‘221582’). Obtain this from the list_status_pages action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_STATUS_PAGE_RESOURCETool to delete an existing resource from a status page. Use when you need to permanently remove a resource (monitor or heartbeat) that is displayed on a status page.

Input Parameters

string
required
The ID of the resource to delete from the status page
string
required
The ID of the status page that contains the resource

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_STATUS_PAGE_SECTIONTool to permanently delete a status page section by ID. Use when you need to remove a section from a status page that is no longer needed. Sections organize resources on status pages for better visibility.

Input Parameters

string
required
The ID of the section to delete from the status page. You can get this from listing sections within a status page.
string
required
The ID of the status page that contains the section to delete. You can get this from the list status pages or get status page actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_STATUS_PAGE_STATUS_REPORT_STATUS_UPDATETool to delete an existing status update from a status report. Use when you need to permanently remove a status update after confirming its ID.

Input Parameters

string
required
The ID of the status page. You can get this from the list_status_pages action.
string
required
The ID of the status report containing the update. You can get this from the list_status_page_reports action.
string
required
The ID of the status update to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_STATUS_PAGE_SUBSCRIBERRemove an e-mail subscriber from a status page by subscriber ID. Creates an unsubscribe record for that e-mail address. Requires a Better Stack Incidents API token with access to the status page.

Input Parameters

string
required
The ID of the subscriber.
string
required
The ID of your status page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_STATUS_PAGE_SUBSCRIBER_BY_EMAILRemove a status page subscriber by exact email address. Creates an unsubscribe record for that email address. Returns no content on success. Requires a Better Stack Incidents API token with access to the status page.

Input Parameters

string
required
The exact subscriber e-mail address.
string
required
The ID of your status page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_TEAM_MEMBER_BY_EMAILRemove a team member or cancel a pending invitation by e-mail. This action cannot be undone. Admins cannot be removed through the API. Removing a billing_admin requires a global API token because that role applies to every team. With a global token, provide team_name to select the team. Sends email and optional team_name as query parameters to the Better Stack organization API.

Input Parameters

string
required
The email address of the team member to remove or invitation to cancel. Can be passed as a query parameter or in the request body.
string
Required if using a global API token to specify the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_TEAM_MEMBER_BY_ID
Remove a team member from team by ID Removes a member from the team by their ID. This action cannot be undone. [info] Removing a user with the admin role is not permitted via the API. Removing a user with the billing_admin role requires a global API token, because Billing admin applies to every team in your organization. [/info] DELETE /api/v2/team-members/{id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the team member to remove.
string
Required if using a global API token to specify the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_URGENCYTool to delete a severity (urgency) by ID. Use when you need to permanently remove an existing severity level after confirming its ID.

Input Parameters

integer
required
The ID of the severity you want to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_DELETE_URGENCY_GROUPTool to permanently delete an urgency group (severity group) by ID. Use when you need to remove an existing severity group that is no longer needed.

Input Parameters

string
required
The ID of the urgency group (severity group) to delete. You can get this from the list urgency groups action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_ESCALATE_INCIDENTTool to escalate an ongoing incident to a user, team, schedule, policy, or organization. Use when you need to route an active incident to the appropriate responders with specified notification channels (call, SMS, email, push).

Input Parameters

boolean
Enable SMS notification
boolean
Enable phone notification
boolean
Enable push notification
boolean
Enable email notification
integer
Team ID to escalate to (required when escalation_type is Team, alternative to team_name)
integer
User ID to escalate to (required when escalation_type is User, alternative to user_email)
object
Additional metadata key-value pairs to attach to the escalation
integer
Policy ID to escalate to (required when escalation_type is Policy)
string
Team name to escalate to (required when escalation_type is Team, alternative to team_id)
string
User email to escalate to (required when escalation_type is User, alternative to user_id)
string
required
The identifier of the incident to escalate
integer
Schedule ID to escalate to (required when escalation_type is Schedule)
boolean
Critical push notification (bypasses Do Not Disturb)
string ("User" | "Team" | "Schedule" | "Policy" | "Organization")
required
Target type: User, Team, Schedule, Policy, or Organization. Determines which additional identifier field is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_EXPORT_DASHBOARD
Export a dashboard Retrieves the full configuration of a dashboard or a public template as a JSON object. This is useful for backing up dashboards or creating new dashboards via the import endpoint. This endpoint can be used to export both your own dashboards and dashboard templates. GET /api/v2/dashboards/{id}/export Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
The unique identifier of the dashboard or template to export.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_ALERT
Get a single alert Retrieves a single alert by its ID from any context (dashboard or exploration). GET /api/v2/alerts/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique integer identifier of the alert.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_AMAZON_SNS_INTEGRATION
Get Amazon SNS integration Returns a single Amazon SNS integration by ID. GET /api/v2/amazon-sns/{amazon_sns_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Amazon SNS integration you want to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_AWS_CLOUDWATCH_INTEGRATION
Get AWS CloudWatch integration Returns a single AWS CloudWatch integration by ID. GET /api/v2/aws-cloudwatch-integrations/{aws_cloudwatch_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the AWS CloudWatch integration you want to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_AWS_LOG_GROUP_SUBSCRIPTIONGet one AWS log group subscription override, including its region, log group name and subscribed state. Requires an aws source with a connected AWS account and a Telemetry API token with access to that source.

Input Parameters

string
required
ID of the log group subscription override
string
required
ID of the aws source

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_AZURE_INTEGRATION
Get Azure integration Returns a single Azure integration by ID. GET /api/v2/azure-integrations/{azure_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Azure integration you want to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_CATALOG_ATTRIBUTE
Get catalog attribute Returns a single Catalog attribute by ID. GET /api/v2/catalog/relations/{relation_id}/attributes/{attribute_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the related Catalog relation.
string
required
The ID of the Catalog attribute you want to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_CATALOG_RECORD
Get a single Catalog record Returns a single Catalog record by ID. GET /api/v2/catalog/relations/{relation_id}/records/{record_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Catalog record you want to get.
string
required
The ID of the related Catalog relation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_CATALOG_RELATION
Get catalog relation Returns a single Catalog relation by ID. GET /api/v2/catalog/relations/{relation_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Catalog relation you want to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_CHART
Get a single chart Retrieves a single chart by its ID from a specific dashboard. GET /api/v2/dashboards/{dashboard_id}/charts/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the chart.
integer
required
The unique identifier of the dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_CHART_COMMENT
Get a single chart comment Returns a single comment from a chart. GET /api/v2/dashboards/{dashboard_id}/charts/{chart_id}/comments/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the comment.
integer
required
The unique identifier of the chart.
integer
required
The unique identifier of the dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_COLLECTOR
Get a single collector Retrieves details for a single collector by its ID. GET /api/v1/collectors/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
The unique identifier of the collector.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_COLLECTOR_METRIC_TARGET
Get a single collector metrics target Returns a single collector target by ID. GET /api/v1/collectors/{collector_id}/targets/{target_id} Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
Identifier of the target.
string
required
Identifier of the collector.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_CONNECTIONRetrieve details of a specific ClickHouse connection by ID. Requires a global API token. Returns connection settings and queryable sources; the password is returned only when creating a connection, not by this action.

Input Parameters

string
required
The ID of the connection to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_DASHBOARD
Get a single dashboard Retrieves detailed information for a single dashboard by its ID, including its charts, sections, and variables. GET /api/v2/dashboards/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
The unique identifier of the dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_DASHBOARD_ALERT
Get a single dashboard alert Retrieves a single alert by its ID, scoped to a specific dashboard chart. GET /api/v2/dashboards/{dashboard_id}/charts/{chart_id}/alerts/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the alert.
integer
required
The unique identifier of the chart.
integer
required
The unique identifier of the dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_DASHBOARD_GROUP
Get a single dashboard group Retrieves a single dashboard group by its ID. GET /api/v2/dashboard-groups/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the dashboard group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_DASHBOARD_SECTION
Get a single dashboard section Retrieves a single section by its ID from a specific dashboard. GET /api/v2/dashboards/{dashboard_id}/sections/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the section.
integer
required
The unique identifier of the dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_DATADOG_INTEGRATION
Get Datadog integration Returns a single Datadog integration by ID. GET /api/v2/datadog-integrations/{datadog_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Datadog integration you want to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_ELASTIC_INTEGRATION
Get Elastic integration Returns a single Elastic integration by ID. GET /api/v2/elastic-integrations/{elastic_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Elastic integration you want to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_EMAIL_INTEGRATION
Get e-mail integration Returns a single e-mail integration by ID. GET /api/v2/email-integrations/:email_integration_id Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the e-mail integration you want to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_ESCALATION_POLICYGet an escalation policy by ID, including its repeat settings, team information, and selected step details.

Input Parameters

string
required
The ID of the escalation policy to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_EXPLORATION
Get a single exploration Retrieves a single exploration by its ID, including the full chart, query, and variable configurations. GET /api/v2/explorations/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the exploration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_EXPLORATION_ALERT
Get a single exploration alert Retrieves a single alert by its ID, scoped to a specific exploration. GET /api/v2/explorations/{exploration_id}/alerts/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the alert.
integer
required
The unique identifier of the exploration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_EXPLORATION_GROUP
Get a single exploration group Retrieves a single exploration group by its ID. GET /api/v2/exploration-groups/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the exploration group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_GOOGLE_MONITORING_INTEGRATION
Get Google Monitoring integration Returns a single Google Monitoring integration by ID. GET /api/v2/google-monitoring-integrations/{google_monitoring_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Google Monitoring integration you want to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_GRAFANA_INTEGRATION
Get Grafana integration Returns a single Grafana integration by ID. GET /api/v2/grafana-integrations/{grafana_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Grafana integration you want to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_HEARTBEATTool to get a single heartbeat by ID. Use when you need to fetch details of a specific heartbeat.

Input Parameters

string
required
The ID of the requested heartbeat

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_HEARTBEAT_AVAILABILITYTool to retrieve availability summary for a specific heartbeat. Use when you need availability metrics for a heartbeat within an optional date range.

Input Parameters

string
End date (inclusive) for the summary in YYYY-MM-DD format
string
Start date (inclusive) for the summary in YYYY-MM-DD format
string
required
ID of the heartbeat to retrieve availability for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_HEARTBEAT_GROUPTool to get a single heartbeat group by ID. Use when you need to fetch details of a specific heartbeat group.

Input Parameters

string
required
The ID of the heartbeat group to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_INCIDENT_COMMENTTool to get a single comment from an incident. Use when you need to retrieve details of a specific comment on a Better Stack incident.

Input Parameters

string
required
The ID of the comment to retrieve
string
required
The ID of the incident containing the comment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_INCOMING_WEBHOOK
Get incoming webhook Returns a single incoming webhook by ID. GET /api/v2/incoming-webhooks/:incoming_webhook_id Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the incoming webhook you want to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_JIRA_INTEGRATION
Get Jira integration Returns a single Jira integration by ID. GET /api/v2/jira-integrations/:jira_integration_id Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Jira integration you want to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_MONITORTool to get a single monitor. Use when you need full details of a specific monitor by its ID.

Input Parameters

string
required
The ID of the monitor to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_MONITOR_AVAILABILITYGet an availability summary for a specific monitor over an optional date range, including uptime percentage, downtime, incident count, and incident duration statistics.

Input Parameters

string
End date (inclusive) for the summary in YYYY-MM-DD format
string
Start date (inclusive) for the summary in YYYY-MM-DD format
string
required
The ID of the monitor to retrieve availability for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_MONITOR_GROUPSTool to get a single monitor group by ID. Use when you need to fetch details of a specific monitor group.

Input Parameters

string
required
The ID of the monitor group to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_MONITOR_GROUPS_MONITORSTool to get all monitors belonging to a monitor group. Use when you need to retrieve all monitors within a specific monitor group, with optional pagination support.

Input Parameters

integer
Page number to return. Starts at 1.
integer
Number of monitors per page. Default is 50, maximum is 250.
integer
required
The ID of the monitor group to retrieve monitors for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_MONITOR_RESPONSE_TIMESRetrieves response time metrics for a specific uptime monitor, including DNS, connection, TLS handshake, and data transfer timings grouped by region. Results are limited to one record per region by default; an optional limit can request more.

Input Parameters

string
Optional end date (inclusive) for filtering response times in ISO 8601 format. If not specified, defaults to now.
string
Optional start date (inclusive) for filtering response times in ISO 8601 format. If not specified, defaults to 24 hours ago.
integer
Maximum number of response time records to return per region. Defaults to 1 if not specified to prevent oversized responses.
string
required
The unique numeric ID of the monitor to retrieve response times for. Obtain this from the list_monitors action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_NEW_RELIC_INTEGRATION
Get New Relic integration Returns a single New Relic integration by ID. GET /api/v2/new-relic-integrations/{new_relic_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the New Relic integration you want to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_ON_CALL_EVENT
Get a single on-call schedule event Get a single event from an on-call schedule. GET /api/v2/on-calls/{schedule_id}/events/{event_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the event to return.
string
required
The ID of the on-call schedule you want to get events for. Use default to refer to the default on-call schedule for the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_ON_CALL_SCHEDULETool to get a single on-call schedule by ID. Use when you need to retrieve who is currently on-call for a specific schedule. Optionally specify a date to check on-call status at a specific time.

Input Parameters

string
ISO-8601-formatted date or date-time for looking up on-call at a specific time
string
required
The ID of the on-call schedule you want to get. Use ‘default’ if you want to get the default on-call

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_OUTGOING_EMAIL
Get outgoing e-mail Returns a single outgoing e-mail integration by ID. GET /api/v2/outgoing-emails/{integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the outgoing e-mail integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_OUTGOING_WEBHOOKTool to get a single outgoing webhook integration by ID. Use when you need to retrieve details of a specific webhook integration.

Input Parameters

string
required
The ID of the Outgoing Webhook integration you want to get. You can get this from the list or create outgoing webhook actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_PAGERDUTY_INTEGRATION
Get PagerDuty integration Returns a single PagerDuty integration by ID. GET /api/v2/pager-duty-webhooks/{pager_duty_webhook_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the PagerDuty integration you want to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_POLICY_GROUPTool to get a single escalation policy group. Use when you need full details of a specific escalation policy group by its ID.

Input Parameters

string
required
The ID of the escalation policy group to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_PRODUCT_USAGERetrieve organization usage or incurred cost for one product, itemized by resource. Requires a global API token. Discover product IDs and dimension names using the usage overview; dimension=cost returns incurred cost. Defaults to the last 30 days, without pagination, with a maximum requested range of 400 days. Buckets align to calendar days, weeks, months or quarters and may extend beyond the requested range. Non-day buckets use date_from/date_to instead of date. Future end dates are clamped to today.

Input Parameters

string
End date in the YYYY-MM-DD format, inclusive. Defaults to today. Future dates are clamped to today.
string
Start date in the YYYY-MM-DD format, inclusive. Defaults to 29 days before to. The range between from and to can span at most 400 days.
string
required
The product id from the usage overview, for example logs, traces, metrics, or monitors.
string
A dimension name from the usage overview, or cost for the product’s incurred cost. Defaults to the product’s default_dimension. Dimension names vary per product and plan, so discover them through the overview.
string ("day" | "week" | "month" | "quarter")
Bucket size: day, week, month, or quarter. Defaults to day.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_PROMETHEUS_INTEGRATION
Get Prometheus integration Returns a single Prometheus integration by ID. GET /api/v2/prometheus-integrations/{prometheus_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Prometheus integration you want to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_SCHEDULE_ROTATION
Get an on-call schedule rotation Returns the currently used on-call rotation for a single on-call schedule. GET /api/v2/on-calls/{schedule_id}/rotation Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
Required if using global API token to specify the team which owns the resource.
string
required
The ID of the on-call schedule you want to get events for. Use default to refer to the default on-call schedule for the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_SLACK_INTEGRATION
Get Slack integration Returns a single Slack integration by ID. GET /api/v2/slack-integrations/{slack_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Slack integration you want to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_SOURCE
Get a single source Get a single source by its ID. GET /api/v2/sources/{source_id} Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
Identifier of the source.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_SOURCE_GROUP
Get a single source group Get a single source group by its ID. GET /api/v1/source-groups/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
The ID of the source group you want to get

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_SPLUNK_INTEGRATION
Get Splunk integration Returns a single Splunk On-Call integration by ID. GET /api/v2/splunk-on-calls/{splunk_on_call_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Splunk On-Call integration you want to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_STATUS_PAGETool to get a single status page by ID. Use when you need detailed information about a specific status page.

Input Parameters

string
required
The ID of the status page to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_STATUS_PAGE_GROUPTool to get a single status page group by ID. Use when you need to retrieve details of a specific status page group.

Input Parameters

string
required
The unique identifier for the specific status page group to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_STATUS_PAGE_REPORTTool to get a single status page report by ID. Use when you need detailed information about a specific status report or incident.

Input Parameters

string
required
The numeric ID of the status report to retrieve (e.g., ‘824274’).
string
required
The numeric ID of the status page (e.g., ‘221582’). Obtain this from the list_status_pages action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_STATUS_PAGE_RESOURCETool to get a single status page resource by ID. Use when you need detailed information about a specific resource on a status page.

Input Parameters

string
required
The ID of the status page resource
string
required
The ID of the status page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_STATUS_PAGE_SECTIONTool to get a single status page section. Use when you need details of a specific section within a status page by its ID.

Input Parameters

string
required
The ID of the section you want to get
string
required
The ID of your status page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_STATUS_PAGE_SUBSCRIBER
Get status page subscriber Returns a single e-mail subscriber of your status page. GET /api/v2/status-pages/{status_page_id}/subscribers/{subscriber_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the subscriber.
string
required
The ID of your status page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_STATUS_UPDATETool to get a single status update by its ID. Use when you need details of a specific status update for a status report on your status page.

Input Parameters

string
required
The ID of your status page. Obtain from list_status_pages action.
string
required
The ID of your status page report. Obtain from list_status_page_reports action.
string
required
The ID of your status update. Obtain from list_status_page_status_report_status_updates action or after creating a status update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_TEAM_MEMBER
Get a single team member Returns a single team member by their ID. This endpoint does not return pending invitations. You can retrieve a specific member or invitation by providing an email query parameter in List all team members API. The role attribute is the team member’s role in the team your API token is scoped to. A user with different roles in different teams returns different values depending on which team’s token you use. Possible values: admin, billing_admin, team_lead, responder, member, or custom. custom is returned when the user has a non-system custom role. GET /api/v2/team-members/{id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the team member.
string
Required if using a global API token to specify the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_UPTIME_API_TOKENTool to retrieve the configured Uptime API token. Use when you need the Uptime API token for subsequent authenticated API calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_URGENCYTool to get a single severity level (urgency) by ID. Use when you need to fetch details of a specific urgency configuration.

Input Parameters

string
required
The ID of the severity level you’re interested in

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_URGENCY_GROUPTool to get a single urgency group (severity group) by ID. Use when you need to fetch details of a specific urgency group.

Input Parameters

string
required
The ID of the urgency group (severity group) to retrieve. You can get this from the list urgency groups action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_GET_USAGE_OVERVIEWGet organization-wide product usage and incurred costs for an inclusive date range. Requires a global API token. Returns all products without pagination, including product IDs, dimensions and default dimensions for subsequent per-product usage queries. Defaults to the last 30 days when from/to are omitted.

Input Parameters

string
End date in the YYYY-MM-DD format, inclusive. Defaults to today. Future dates are clamped to today.
string
Start date in the YYYY-MM-DD format, inclusive. Defaults to 29 days before to. The range between from and to can span at most 400 days.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_IMPORT_DASHBOARDCreate a new dashboard from exported JSON, queuing its import asynchronously. Set name or data.name. The response is a minimal dashboard representation; charts and sections may not yet reflect their final imported configuration. Requires a Telemetry API token; global tokens also require team_name.

Input Parameters

object
required
The dashboard configuration data in JSON format, typically obtained from the Export dashboard endpoint. This object can include a name key for the new dashboard. At least one of the top-level name parameter or data.name must be set.
string
A name for the new dashboard. If not provided, the name field within the data parameter will be used. At least one of these name fields must be set.
string
Required if using global API token to specify the team which should own the resource

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_INVITE_TEAM_MEMBERInvite a user to your organization or add an existing member to another team. Authenticate with a global API token and team_name, or a team-scoped Incidents API token. Assign role by name or role_id from List roles (including custom roles); both must match if supplied together. Defaults to responder. Admin invitations are forbidden. Billing admin invitations require a global token because the role applies across the organization. Returns an invitation when sent (201), or existing member details if already in the team (200).

Input Parameters

string ("responder" | "member" | "team_lead" | "billing_admin")
The role to assign to the user. Defaults to responder. Use role_id to assign a custom role. Assigning billing_admin requires a global API token.
string
required
The e-mail address of the user to invite.
string
The ID of the role to assign, including custom roles, as returned by the List roles API. Provide either role or role_id. If both are given they must reference the same role.
string
Required if using a global API token to specify the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_ALERTSList alerts accessible to the user across all dashboards and explorations. Returns one page; use page/per_page and the returned pagination links to continue. Requires a Telemetry API token with access to the resource.

Input Parameters

integer
Page number for pagination.
integer
Number of items per page (max 250).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_AMAZON_SNS_INTEGRATIONSList one page of Amazon SNS integrations, optionally filtered by team. Use page/per_page and returned pagination links to continue. Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

integer
The page number to return, starting with 1.
integer
Number of results per page. Defaults to 50, maximum 250.
string
Filter integrations belonging to a specified team when using global API token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_AWS_CLOUDWATCH_INTEGRATIONSTool to list all AWS CloudWatch integrations. Use when you need to retrieve and inspect all configured AWS CloudWatch on-call integrations.

Input Parameters

integer
Page number to return. Starts at 1.
integer
Number of integrations per page. Default is 50, maximum is 250.
string
Filter integrations belonging to a specified team. Only valid when using a global API token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_AWS_LOG_GROUP_SUBSCRIPTIONSList one page of Amazon CloudWatch log group subscription overrides for an aws source with an AWS account already connected. Overrides specify whether Better Stack ingests each log group and take precedence over the source’s auto-subscribe setting. Returns overrides, not every discovered log group. Use page/per_page and returned pagination links to continue. Requires a Telemetry API token with access to the source.

Input Parameters

integer
Page number
integer
Number of subscriptions per page. Default 50, maximum 250.
string
required
ID of the aws source with an AWS account already connected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_AZURE_INTEGRATIONSTool to list all Azure integrations. Use when you need to retrieve and inspect all configured Azure on-call integrations.

Input Parameters

integer
Page number to return. Starts at 1.
integer
Number of integrations per page. Default is 50, maximum is 250.
string
Filter integrations belonging to a specified team. Only valid when using a global API token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_CATALOG_ATTRIBUTES
List catalog attributes Returns a list of all Catalog attributes for a Catalog relation. GET /api/v2/catalog/relations/{relation_id}/attributes Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the Catalog relation you want to get attributes for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_CATALOG_RECORDSList one page of Catalog records for a relation. Use page/per_page and returned pagination links to continue. Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

integer
The page number to return, starting with 1.
integer
Number of results per page. Defaults to 50, maximum 250.
string
required
The ID of the Catalog relation you want to get records for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_CATALOG_RELATIONSTool to list all catalog relations. Use when you need to retrieve all catalog relations, supports pagination.

Input Parameters

integer
Page number to return. Starts at 1.
integer
Number of resources per page. Default is 50, maximum is 250.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_CHART_COMMENTSList one page of chart comments ordered by pinned time, oldest first. Use page/per_page and returned pagination links to continue. Requires a Telemetry API token with access to the resource.

Input Parameters

integer
Page number for pagination.
integer
required
The unique identifier of the chart.
integer
Number of items per page (max 250).
integer
required
The unique identifier of the dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_CHARTS
List all charts Retrieves a list of all charts on a specific dashboard. GET /api/v2/dashboards/{dashboard_id}/charts Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_COLLECTOR_HOSTS
List hosts where a collector is running Returns a list of hosts where the specified collector is running. GET /api/v1/collectors/{id}/hosts Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
The unique identifier of the collector.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_COLLECTOR_METRICS_TARGETSList one page of metrics targets belonging to a collector. Use page/per_page and returned pagination links to continue. Requires a Telemetry API token with access to the resource.

Input Parameters

integer
Page number for pagination.
integer
Number of items per page. Default 50, maximum 250.
string
required
Identifier of the collector.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_COLLECTORSList one page of collectors accessible by the authenticated user. Use page/per_page and returned pagination links to continue. Requires a Telemetry API token with access to the collectors.

Input Parameters

string
Filter collectors by name (case-insensitive partial match).
integer
Page number for pagination. Defaults to 1 when omitted.
integer
Number of items per page (max 250). Defaults to 50 when omitted.
string
Required if using a global API token to filter for a specific team. If omitted, collectors from all teams in the organization are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_CONNECTIONSList one page of ClickHouse connections. Use page/per_page and the returned pagination links to continue. Retrieve an individual connection for full details including data sources. Passwords are returned only when creating a connection. Requires a global Telemetry API token; team-specific tokens cannot authenticate this endpoint.

Input Parameters

integer
Page number for pagination
integer
Number of items per page (default: 50, max: 250)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_DASHBOARD_ALERTS
List all alerts in a dashboard Retrieves all alerts associated with a specific dashboard chart. This endpoint is not paginated. GET /api/v2/dashboards/{dashboard_id}/charts/{chart_id}/alerts Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the chart.
integer
required
The unique identifier of the dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_DASHBOARD_GROUPSList one page of your team’s dashboard groups. Use page/per_page and the returned pagination links to continue. Requires a Telemetry API token with access to the resource.

Input Parameters

integer
Page number for pagination.
integer
Number of items per page (max 250).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_DASHBOARDSList one page of the team’s dashboards, optionally filtered by name or dashboard group. Returns summarized dashboard attributes, not full variables, charts, or sections; retrieve an individual dashboard for its full configuration. Use page/per_page and the returned pagination links to continue. Requires a Telemetry API token.

Input Parameters

integer
Page number for pagination. Defaults to 1 at the provider.
string
Search for dashboards by name.
integer
Number of items per page. Defaults to 50 at the provider; maximum 250.
integer
Filter dashboards by the ID of a dashboard group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_DASHBOARD_SECTIONS
List all dashboard sections Retrieves a list of all sections on a specific dashboard. This endpoint is not paginated; it returns all sections for a given dashboard in a single response. GET /api/v2/dashboards/{dashboard_id}/sections Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_DASHBOARDS_IN_GROUP
List dashboards in a group Retrieves a paginated list of dashboards within a specific group. GET /api/v2/dashboard-groups/{id}/dashboards Returns one page; use page/per_page and the returned pagination links to continue. Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the dashboard group.
integer
Page number for pagination.
string
Search for dashboards by name within the group.
integer
Number of items per page (max 250).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_DASHBOARD_TEMPLATES
List dashboard templates Retrieves a list of all available dashboard templates. This endpoint is not paginated and returns all available templates in a single response. [note] The id returned for each template can be used with the Export dashboard endpoint to retrieve the full JSON configuration for that template. [/note] GET /api/v2/dashboards/templates Requires a Telemetry API token with access to the resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_DATADOG_INTEGRATIONSTool to list all Datadog integrations. Use when you need to retrieve and inspect all configured Datadog on-call integrations.

Input Parameters

integer
Page number to return. Starts at 1.
integer
Number of integrations per page. Default is 50, maximum is 250.
string
Filter integrations belonging to a specified team. Only valid when using a global API token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_ELASTIC_INTEGRATIONSTool to list Elastic integrations. Use when you need to retrieve and inspect all configured Elastic integrations.

Input Parameters

integer
Page number to return. Starts at 1.
integer
Number of integrations per page. Default is 50, maximum is 250.
string
Filter integrations by team name. Useful when using a global API token to narrow results to a specific team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_EMAIL_INTEGRATIONSTool to list email integrations. Use when you need to retrieve and inspect all configured email integrations with optional team filtering and pagination support.

Input Parameters

integer
Page number to return. Starts at 1.
string
Filter email integrations by team name. Useful when using a global API token to narrow results to a specific team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_EXPLORATION_ALERTS
List all alerts in an exploration Retrieves all alerts associated with a specific exploration. This endpoint is not paginated. GET /api/v2/explorations/{exploration_id}/alerts Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the exploration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_EXPLORATION_GROUPSList one page of the team’s exploration groups. Use page/per_page and returned pagination links to continue. Requires a Telemetry API token with access to the resource.

Input Parameters

integer
Page number for pagination.
integer
Number of items per page (max 250).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_EXPLORATIONSList one page of your team’s exploration summaries. Use page/per_page and the returned pagination links to continue. For full chart, query, and variable configurations, retrieve an individual exploration. Requires a Telemetry API token with access to the resource.

Input Parameters

integer
Page number for pagination.
integer
Number of items per page (max 250).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_EXPLORATIONS_IN_GROUP
List explorations in a group Retrieves a paginated list of explorations within a specific group. GET /api/v2/exploration-groups/{id}/explorations Returns one page; use page/per_page and the returned pagination links to continue. Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the exploration group.
integer
Page number for pagination.
string
Search for explorations by name within the group.
integer
Number of items per page (max 250).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_GOOGLE_MONITORING_INTEGRATIONSTool to list all Google Monitoring integrations. Use when you need to view your configured Google Monitoring on-call integrations with pagination support.

Input Parameters

integer
Page number to return. Starts at 1.
integer
Number of integrations per page. Default is 50, maximum is 250.
string
Filter integrations by team name. Only returns integrations belonging to the specified team. Useful when using a global API token to filter results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_GRAFANA_INTEGRATIONSTool to list all Grafana integrations. Use when you need to retrieve and inspect all configured Grafana integrations.

Input Parameters

integer
Page number for pagination. Defaults to 1.
string
Filter integrations belonging to a specified team. Only valid when using a global API token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_HEARTBEAT_GROUPSLists a page of heartbeat groups, with optional team-name filtering and pagination controls.

Input Parameters

integer
Page number to return. Starts at 1.
integer
Number of heartbeat groups per page. Default is 50, maximum is 250.
string
Filter heartbeat groups belonging to a specified team when using global API token

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_HEARTBEATSLists a page of configured uptime heartbeats, with optional pagination and team-name filtering.

Input Parameters

integer
Page number to return. Starts at 1.
string
Filter heartbeats belonging to a specific team. Only applicable when using a global API token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_INCIDENTS_COMMENTSTool to list all comments on an incident. Use when you need to retrieve all comments associated with a Better Stack incident.

Input Parameters

string
required
The ID of the incident to list comments for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_INCIDENTS_TIMELINETool to retrieve all timeline events for an incident. Use when you need to get a chronological history of events, comments, responses, and changes for a specific incident in Better Stack. Returns all timeline items without pagination.

Input Parameters

string
required
The ID of the incident to get timeline events for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_INCIDENTS_UPTIMETool to list all incidents with optional filtering by monitor, heartbeat, date range, or resolution status. Supports pagination with default of 10 per page and maximum of 50.

Input Parameters

string
Return incidents until a certain date (format YYYY-MM-DD)
string
Return only incidents from a certain date (format YYYY-MM-DD)
integer
Page number to return. Starts at 1.
integer
Number of incidents per page. Default is 10, maximum is 50.
boolean
List only resolved or unresolved incidents. Use false to list active incidents
string
Filter incidents belonging to a specified team when using global API token
integer
Filter incidents belonging to a specified monitor
integer
Filter incidents belonging to a specified heartbeat

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_INCOMING_WEBHOOKSList one page of incoming webhooks. Use page/per_page and returned pagination links to continue. Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

integer
The page number to return, starting with 1.
integer
Number of results per page. Defaults to 50, maximum 250.
string
Filter incoming webhooks belonging to a specified team when using global API token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_JIRA_INTEGRATIONSList Jira integrations with optional team filtering and pagination.

Input Parameters

integer
Page number to return. Starts at 1.
integer
Number of integrations per page. Default is 50, maximum is 250.
string
Filter integrations belonging to a specified team. Only valid when using a global API token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_METADATAList metadata records with optional filtering by team, owner resource ID, or owner resource type, and pagination.

Input Parameters

integer
Page number to return. Starts at 1.
string
Targets metadata for a particular resource
integer
Number of metadata records per page. Default is 50, maximum is 250.
string
Filters results to a specific team (global tokens only)
string ("Monitor" | "Heartbeat" | "Incident" | "WebhookIntegration" | "EmailIntegration" | "IncomingWebhook" | "CallRouting")
Owner types for metadata resources.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_METRICSList one page of metrics and labels for a specified source. Use page/per_page and returned pagination links to continue. Requires a Telemetry API token with access to the resource.

Input Parameters

integer
Page number
integer
Number of metrics per page. Default 50, maximum 250.
integer
required
Source for which to retrieve metrics

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_MONITORED_DATABASES
Lists databases monitored by a collector Returns a list of databases currently being monitored by the specified collector. [info] For security reasons, passwords are never included in the API response. [/info] GET /api/v1/collectors/{id}/databases Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
The unique identifier of the collector.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_MONITOR_GROUPSTool to list all monitor groups. Use when you need to retrieve existing monitor groups with optional team filtering and pagination support.

Input Parameters

integer
Page number to return. Starts at 1.
integer
Number of monitor groups per page. Default is 50, maximum is 250.
string
Filters results to monitor groups belonging to a specified team when using a global API token

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_MONITORSTool to list all monitors. Use when you need to retrieve existing uptime monitors with optional filtering by URL or name and pagination.

Input Parameters

string
Filter monitors by their URL property
integer
Page number to return. Starts at 1.
integer
Number of monitors per page. Default is 50, maximum is 250.
string
Filter monitors by their pronounceable name property

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_NEW_RELIC_INTEGRATIONSTool to list New Relic integrations. Use when you need to retrieve and inspect all configured New Relic integrations with pagination support.

Input Parameters

integer
Page number to return. Starts at 1.
integer
Number of integrations per page. Default is 50, maximum is 250.
string
Filter integrations by team name. Useful when using a global API token to narrow results to a specific team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_ON_CALL_EVENTSTool to list all events for a specific on-call schedule. Use when you need to retrieve the calendar of scheduled on-call periods for a team.

Input Parameters

string
required
Identifier for the on-call schedule. Use ‘default’ to reference the team’s default schedule.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_ON_CALL_SCHEDULESTool to list all on-call schedules. Use when you need to retrieve all configured on-call calendars.

Input Parameters

integer
Page number to return. Starts at 1.
integer
Number of resources per page. Default is 50, maximum is 250.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_OUTGOING_EMAILSList one page of outgoing e-mail integrations. Use page/per_page and the returned pagination links to continue. Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

integer
The page number to return, starting with 1.
integer
Number of results per page. Defaults to 50, maximum 250.
string
Filter outgoing e-mail integrations belonging to a specified team when using a global API token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_OUTGOING_WEBHOOKSTool to list all outgoing webhook integrations. Use when you need to retrieve configured webhook endpoints for event notifications.

Input Parameters

integer
Page number to return. Starts at 1.
string
Filter outgoing webhooks belonging to a specified team. Only applicable when using a global API token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_PAGER_DUTY_WEBHOOKSTool to list PagerDuty integrations. Use when you need to retrieve and inspect all configured PagerDuty integrations.

Input Parameters

integer
Page number to return. Starts at 1.
integer
Number of integrations per page. Default is 50, maximum is 250.
string
Filter integrations by team name. Useful when using a global API token to narrow results to a specific team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_POLICIESTool to list all escalation policies. Use when you need to retrieve existing escalation policies with optional filtering by team name.

Input Parameters

integer
Page number to return. Starts at 1.
integer
Number of policies per page. Default is 50, maximum is 250.
string
Filter escalation policies by team name when using global API token

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_POLICY_GROUPSTool to list all escalation policy groups. Use when you need to retrieve existing policy groups with optional team filtering and pagination support.

Input Parameters

integer
Page number to return. Starts at 1.
integer
Number of policy groups per page. Default is 50, maximum is 250.
string
Filter policy groups belonging to a specified team when using global API token

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_PROMETHEUS_INTEGRATIONSList configured Prometheus on-call integrations, with optional team filtering and pagination. Each request returns one page of results.

Input Parameters

integer
Page number to return. Starts at 1.
integer
Number of integrations per page. Default is 50, maximum is 250.
string
Filter integrations belonging to a specified team. Only valid when using a global API token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_ROLESList every organization role in one unpaginated response. Built-in roles (admin, billing_admin, team_lead, responder, member) are returned first, then custom roles. Custom roles share role=‘custom’; distinguish them by id and name. Pass a role’s id as role_id when inviting team members or updating their roles. Requires a Global or Uptime API token; no team_name is needed, including for global tokens spanning multiple teams.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_SINGLE_INCIDENTTool to retrieve detailed information about a single incident by its ID. Use when you need to get the full details of a specific incident including its status, timeline, affected regions, and notification settings.

Input Parameters

string
required
The ID of the incident to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_SLACK_INTEGRATIONSList configured Slack channel integrations, with optional team filtering and pagination. Each request returns one page of results.

Input Parameters

integer
Page number to return. Starts at 1.
integer
Number of integrations per page. Default is 50, maximum is 250.
string
Filter Slack integrations belonging to a specified team. Only valid when using a global API token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_SOURCE_GROUPSList one page of your team’s source groups. Use page/per_page and returned pagination links to continue. Requires a Telemetry API token with access to the resource.

Input Parameters

integer
Page number
integer
Number of source groups per page. Default 50, maximum 250.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_SOURCESList one page of your team’s existing Telemetry sources. Use page/per_page and the returned pagination links to continue. Includes source configuration and ingestion tokens. Requires a Telemetry API token with access to the sources.

Input Parameters

integer
Page number, starting at 1.
integer
Number of sources per page. Default 50, maximum 250.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_SOURCES_IN_GROUPList one page of sources in a source group. Use page/per_page and returned pagination links to continue. Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
The ID of the source group.
integer
Page number
integer
Number of sources per page. Default 50, maximum 250.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_SPLUNK_ON_CALL_INTEGRATIONSList configured Splunk On-Call integrations, with optional team filtering and pagination. Each request returns one page of results.

Input Parameters

integer
Page number to return. Starts at 1.
integer
Number of integrations per page. Default is 50, maximum is 250.
string
Filter integrations belonging to a specified team. Only valid when using a global API token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_STATUS_PAGE_GROUPSTool to list all status page groups. Use when you need to retrieve existing status page groups with optional pagination.

Input Parameters

integer
Page number to return. Starts at 1.
integer
Number of status page groups per page. Default is 50; maximum is 250.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_STATUS_PAGE_GROUPS_STATUS_PAGESTool to list status pages within a specific status page group. Use when you need to retrieve all status pages belonging to a particular group with optional pagination.

Input Parameters

integer
Page number to return. Starts at 1.
string
required
The ID of the status page group to list status pages from
integer
Number of status pages per page. Default is 50; maximum is 250.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_STATUS_PAGE_REPORTSTool to list all reports on a status page. Use when you need to retrieve existing status page reports with optional pagination via page and per_page.

Input Parameters

integer
Page number to return. Starts at 1.
integer
Number of reports per page. Default is 50, maximum is 250.
string
required
The numeric ID of the status page (e.g., ‘221582’). Obtain this from the list_status_pages action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_STATUS_PAGE_REPORT_STATUS_UPDATESTool to list all status updates for a status page report. Use when you need to retrieve updates posted on a specific status page report with optional pagination.

Input Parameters

integer
Page number for pagination. Starts at 1.
integer
Number of items per page. Default is 50, maximum is 250.
string
required
Identifier for your status page report. Obtain this from the list_status_page_reports action.
string
required
Identifier for your status page. Obtain this from the list_status_pages action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_STATUS_PAGESTool to list all your status pages. Use when you need to retrieve existing status pages with optional pagination.

Input Parameters

integer
Page number to return. Starts at 1.
integer
Number of status pages per page. Default is 50; maximum is 250.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_STATUS_PAGE_SECTIONSList sections of a specific status page, with pagination.

Input Parameters

integer
Page number to return. Starts at 1.
integer
Number of sections per page. Default is 50, maximum is 250.
string
required
The identifier for your status page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_STATUS_PAGES_RESOURCESTool to list all resources on a status page. Use when you need to retrieve existing resources with optional pagination.

Input Parameters

integer
Page number to return. Starts at 1.
integer
Number of resources per page. Default is 50; maximum is 250.
string
required
The ID of the status page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_STATUS_PAGE_SUBSCRIBERS
List status page subscribers Returns a list of the existing e-mail subscribers of your status page. GET /api/v2/status-pages/{status_page_id}/subscribers Returns one page; use page/per_page and the returned pagination links to continue. Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

integer
The page number to return, starting with 1.
integer
Number of results per page. Defaults to 50, maximum 250.
string
required
The ID of your status page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_TEAM_MEMBERSList one page of team members and pending invitations, or find one by email. Providing email returns a single member or invitation object. Otherwise, use page/per_page and returned pagination links to continue. The role is team-specific: admin, billing_admin, team_lead, responder, member, or custom. A custom-role invitation returns null for role. Requires an Uptime or global API token; global tokens may require team_name to select a team.

Input Parameters

integer
The page number to return, starting with 1.
string
Filter by a specific e-mail address. If provided, returns a single member or invitation object instead of a list.
integer
Number of results per page. Defaults to 50, maximum 250.
string
Required if using a global API token to specify the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_URGENCIESList incident severity levels (urgencies) and their notification settings, optionally filtered by team. Results are paginated.

Input Parameters

string
Filters severities belonging to a specified team when using a global API token

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_LIST_URGENCY_GROUPSTool to list all urgency groups (severity groups). Use when you need to retrieve existing urgency groups with optional team filtering and pagination support.

Input Parameters

integer
Page number to return. Starts at 1.
integer
Number of urgency groups per page. Default is 50, maximum is 250.
string
Filter urgency groups belonging to a specified team when using global API token

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_REOPEN_INCIDENTReopen a resolved incident, optionally identifying who reopened it. Requires a Better Stack Incidents API token with access to the incident. Shared incidents cannot be reopened by the receiving team (403). Returns 409 if the incident is not resolved, its monitor has another open incident, or the reopen window has expired.

Input Parameters

string
required
The ID of the incident you want to reopen.
string
User e-mail or a custom identifier of the entity that reopened the incident.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_RESOLVE_INCIDENTTool to resolve an ongoing incident. Use when you need to mark an incident as resolved and close it. Resolving an incident signals that the issue has been fixed and stops any further escalations.

Input Parameters

string
required
The ID of the incident to resolve
string
Email or custom identifier of the person or system resolving the incident

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_ALERT
Update an alert Updates an existing alert by its ID. You only need to provide the fields you want to change. PATCH /api/v2/alerts/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the alert to update.
boolean
Enable SMS notifications. Only used if escalation_target is not a policy.
boolean
Enable phone call notifications. Only used if escalation_target is not a policy.
string
A new name for the alert.
boolean
Enable push notifications. Only used if escalation_target is not a policy.
boolean
Enable e-mail notifications. Only used if escalation_target is not a policy.
number
The numeric value for the alert condition. For threshold alerts, this is the static threshold. For relative alerts, this is the percentage change. Required for threshold and relative types unless string_value is set. A value of 0 is valid.
boolean
Whether the alert should be paused or active.
object
A key-value object for custom metadata to be included in incidents. Both keys and values must be strings. This will replace all existing metadata. For details, see Metadata.
string ("equal" | "not_equal" | "higher_than" | "higher_than_or_equal" | "lower_than" | "lower_than_or_equal" | "increases_by" | "decreases_by" | "changes_by")
The comparison operator. Required for threshold and relative alerts. For threshold: equal, not_equal, higher_than, higher_than_or_equal, lower_than, lower_than_or_equal. For relative: increases_by, decreases_by, changes_by. Not used for anomaly_rrcf alerts.
string ("threshold" | "relative" | "anomaly_rrcf")
The type of alert. threshold for static values, relative for percentage changes, or anomaly_rrcf for ML-based anomaly detection. Cannot be changed after creation.
string ("source_variable" | "platforms_single_source" | "platforms_all_sources")
The mode for source selection. Valid values: source_variable, platforms_single_source, platforms_all_sources.
integer
How often to evaluate the alert condition, in seconds. Required for threshold and relative alert types. Not used for anomaly_rrcf alerts.
integer
The time window in seconds for the data being analyzed. If not provided, falls back to aggregation_interval, then check_period.
array
An array of strings to filter the alert to specific data series. Cannot be combined with series_names_except. Send an empty array to alert on any series.
string
An alternative to value for threshold alerts when matching an exact string. If string_value is set, value is not required. Only valid with equal or not_equal operators.
string
A custom name template for the incident created by this alert, in plain text. Supports the same variables as incident_cause, such as {{alert_name}} and {{series_name}}. When empty, the incident is named after the dashboard or exploration and the alert. Send null to clear it.
boolean
Enable critical push notifications that bypass Do Not Disturb. Only used if escalation_target is not a policy.
string
A custom description template for the incident created by this alert. Supports {{value}} placeholder.
string ("any" | "higher" | "lower")
Defines which anomalies trigger an alert: any (both higher and lower), higher, or lower. Only for anomaly_rrcf alerts.
string ("treat_as_zero" | "dont_fire" | "treat_as_previous" | "start_incident")
What to do when the query returns no data: treat_as_zero, dont_fire, treat_as_previous, or start_incident. Only for threshold and relative alerts. Default: dont_fire.
integer
The duration in seconds that a condition must be resolved before an incident is recovered. A value of 0 recovers the incident immediately, null means never automatically recover an incident.
string
The variable name for the source selection. If not provided, derived automatically from the dashboard/exploration preset’s source variable.
array
An array of platform names to filter the sources this alert runs on.
string
Defines where to send notifications. Defaults to current_team, for details see Escalation targets.
number
How far the value must deviate from its predicted value to trigger an alert, from 1 to 10. Higher values require a larger deviation and trigger fewer alerts. Shown as Significance in the app. Only for anomaly_rrcf alerts. Default: 5.
integer
The duration in seconds that a condition must be met before an alert is triggered. A value of 0 triggers the alert immediately.
boolean
Whether a separate incident will be created for each data series that triggers the alert.
array
An array of strings to alert on all data series except the listed ones. Cannot be combined with series_names.
integer
The size of data buckets in seconds for aggregating and evaluating the metric. If not provided, falls back to query_period, then check_period.
integer
How many days of history the anomaly detection model is trained on, from 1 to 30. Only for anomaly_rrcf alerts. Default: 7.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_AMAZON_SNS_INTEGRATIONUpdate an existing Amazon SNS integration, sending only fields to change. Included rule/field collections replace their existing entries entirely; omit them to preserve existing entries. topic_arn and subscription_state are read-only. Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

boolean
Send an SMS to the on-call person.
boolean
Call the on-call person.
string
The name of the Amazon SNS integration that you can see in the dashboard.
boolean
Send a push notification to the on-call person.
boolean
Send an e-mail to the on-call person.
boolean
Set to true to pause the integration, false to unpause it.
string
ID of the escalation policy for incidents from this integration, or null to remove it. Without one, incidents alert the current on-call person through the channels set by call, sms, email, and push.
integer
How long we wait before escalating the incident to the team. In seconds. Send null to never escalate to the team, or 0 to alert the whole team right away.
object
Cause extraction object. Required field_target: sns_envelope, body, json, xml, query_string, header. body/json/xml read the publisher message; query_string/header read AWS’s HTTPS request, not the message. target_field: dot path for json/query_string, header name for header, CSS selector for xml, or TopicArn/MessageId/Subject for sns_envelope; unused for body. Required match_type: match_everything (whole value), match_before, match_after, match_between, match_regex (match or capture group). content is required for match_before/match_after (boundary text) and match_regex (regex). content_before and content_after are required for match_between.
object
How to extract a custom incident title, as a field object with the same keys as cause_field. Send null to remove it and use the default title.
array
The conditions started_rule_type checks, as an array of rule objects with the keys below. At least one rule is required when the type is any or all. Nested fields: started_rules[].rule_target: Which part of the notification the rule checks: sns_envelope for the envelope, body, json, or xml for the message your publisher sent, or query_string or header for AWS’s own HTTPS request, which never contains your message.; started_rules[].target_field: Which value to read: a dot-separated path such as alert.id for json and query_string, a header name for header, a CSS selector for xml, or TopicArn, MessageId, or Subject for sns_envelope. Not used with body.; started_rules[].match_type: How to compare the value with content: contains, contains_not, equals, equals_not, matches_regex, or matches_regex_not.; started_rules[].content: The value to compare with. Must be a valid regular expression for matches_regex and matches_regex_not.
boolean
Send a critical push notification that ignores the mute switch and Do Not Disturb mode.
array
The conditions resolved_rule_type checks, as rule objects with the same keys as started_rules.
integer
How long to wait after a notification matching resolved_rules arrives before marking an incident as resolved, in seconds: 0, 60, 180, 300, 900, 1800, 3600, or 7200. Has no effect while resolved_rule_type is unused.
string ("unused" | "any" | "all")
When notifications start an incident: unused always, any when at least one of started_rules matches, or all when all of them match.
array
The conditions acknowledged_rule_type checks, as rule objects with the same keys as started_rules.
string ("unused" | "any" | "all")
When notifications resolve an incident: unused never, any when at least one of resolved_rules matches, or all when all of them match. Any other value requires started_alert_id_field and resolved_alert_id_field.
array
Extra values to extract when an incident starts, saved as incident metadata. Each field object has the same keys as cause_field, plus name. Nested fields: other_started_fields[].name: The metadata key to save the extracted value under. Must be unique within the array.
array
Extra values to extract when an incident is resolved, with the same keys as other_started_fields.
string ("unused" | "any" | "all")
When notifications acknowledge an incident: unused never, any when at least one of acknowledged_rules matches, or all when all of them match. Any other value requires started_alert_id_field and acknowledged_alert_id_field.
object
How to extract the alert ID from the notification that starts an incident, with the same keys as cause_field; later notifications acknowledge and resolve the incident by matching it. Required when acknowledged_rule_type or resolved_rule_type isn’t unused.
object
How to extract the alert ID from a notification that resolves an incident, with the same keys as cause_field. Required when resolved_rule_type isn’t unused.
string
required
The ID of the Amazon SNS integration you want to update
array
Extra values to extract when an incident is acknowledged, with the same keys as other_started_fields.
object
How to extract the alert ID from a notification that acknowledges an incident, with the same keys as cause_field. Required when acknowledged_rule_type isn’t unused.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_AWS_CLOUDWATCH_INTEGRATION
Update AWS CloudWatch integration Update an existing AWS CloudWatch integration. Send only the parameters you wish to change (eg. paused). PATCH /api/v2/aws-cloudwatch-integrations/{aws_cloudwatch_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

boolean
Send an SMS to the on-call person.
boolean
Call the on-call person.
string
The name of the AWS CloudWatch integration that you can see in the dashboard.
boolean
Send a push notification to the on-call person.
boolean
Send an e-mail to the on-call person.
boolean
Set to true to pause the integration, false to unpause it.
string
ID of the escalation policy associated with the AWS CloudWatch integration.
integer
How long we wait before escalating the incident alert to the team. In seconds.
boolean
Send a critical push notification that ignores the mute switch and Do not Disturb mode.
integer
Has no effect for this integration, since an incident resolves as soon as AWS CloudWatch reports the alert as resolved.
string
required
The ID of the AWS CloudWatch integration you want to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_AWS_LOG_GROUP_SUBSCRIPTIONSubscribe or unsubscribe an existing AWS log group override. Set subscribed to true to ingest the log group or false to skip it. The override takes precedence over automatic subscription. Requires an aws source with a connected AWS account and a Telemetry API token with access to the resource.

Input Parameters

string
required
ID of the log group subscription override
string
required
ID of the aws source
boolean
required
Whether to ingest this log group. Set to true to subscribe or false to skip it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_AZURE_INTEGRATION
Update Azure integration Update an existing Azure integration. Send only the parameters you wish to change (eg. paused). PATCH /api/v2/azure-integrations/{azure_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

boolean
Send an SMS to the on-call person.
boolean
Call the on-call person.
string
The name of the Azure integration that you can see in the dashboard.
boolean
Send a push notification to the on-call person.
boolean
Send an e-mail to the on-call person.
boolean
Set to true to pause the integration, false to unpause it.
string
ID of the escalation policy associated with the Azure integration.
integer
How long we wait before escalating the incident alert to the team. In seconds.
boolean
Send a critical push notification that ignores the mute switch and Do not Disturb mode.
integer
Has no effect for this integration, since an incident resolves as soon as Azure reports the alert as resolved.
string
required
The ID of the Azure integration you want to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_CATALOG_ATTRIBUTE
Update catalog attribute Update an existing Catalog attribute. PATCH /api/v2/catalog/relations/{relation_id}/attributes/{attribute_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The name of the Catalog attribute. Required on every update, even when it doesn’t change.
boolean
Whether this is a primary attribute. Primary attributes are matched against the incident metadata key of the same name, the other attributes are added to matching incidents as metadata.
integer
The position of the attribute in the Catalog relation, lower values first.
string
required
The ID of the Catalog relation you want to update an attribute for.
string
required
The ID of the Catalog attribute you want to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_CATALOG_RECORDUpdate a Catalog record, replacing all its attribute values. Attributes omitted from the supplied array become empty. Requires a Better Stack Incidents API token with access to the relation and record.

Input Parameters

string
required
The ID of the Catalog record you want to update.
array
required
The attributes for the Catalog record, in the same format as when creating a Catalog record. Replaces all of the record’s values, so an attribute you leave out ends up empty.
string
required
The ID of the Catalog relation you want to update a record for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_CATALOG_RELATION
Update catalog relation Update an existing Catalog relation. PATCH /api/v2/catalog/relations/{relation_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The name of the Catalog relation. Required on every update, even when it doesn’t change.
string ("any" | "all")
any applies a record when at least one of its primary attribute values matches the incident’s metadata. all applies it only when every primary attribute value matches, with an empty value matching anything.
string
A description of the Catalog relation.
string
required
The ID of the Catalog relation you want to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_CHART
Update a chart Updates an existing chart by its ID. You only need to provide the fields you want to change. [info] When updating queries, the entire array will be replaced with the one you provide. Partial updates to queries are not supported. [/info] PATCH /api/v2/dashboards/{dashboard_id}/charts/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the chart to update.
string
A new name for the chart.
integer
A new width in grid units.
integer
A new height in grid units.
array
A new array of query objects replacing the entire existing array. Partial query updates are not supported.
object
A new JSON object for chart-specific settings (e.g., units, stacking). This will replace the entire existing settings object.
string
A new type for the chart. The new type must be compatible with the chart’s existing queries.
string
A new description for the chart.
integer
required
The unique identifier of the dashboard.
integer
A new vertical position.
integer
A new horizontal position.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_CHART_COMMENTUpdate a chart comment’s Markdown content or pinned time; send only changed fields. API-authored comments can be updated. With OAuth, the token’s team member can also update their own comments. Other comments, including synced incident comments, return 403. user_email is not accepted; change mentions by sending the whole content. Requires a Telemetry API token with access.

Input Parameters

integer
required
The unique identifier of the comment to update.
string
The new content of the comment. Markdown is supported for formatting.
integer
required
The unique identifier of the chart.
string
The new point on the chart’s time axis to pin the comment to, as a datetime such as 2026-08-17T13:00:00Z.
integer
required
The unique identifier of the dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_COLLECTOR
Update a collector Updates an existing collector. Only the provided parameters will be changed. [warning] The platform and data_region attributes are immutable and cannot be changed after a collector is created. A custom bucket can only be added when creating a collector. [/warning] PATCH /api/v1/collectors/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
The unique identifier of the collector to update.
string
A new unique name for the collector.
string
A new note for the collector. Send null to clear the existing note.
array
An array of database objects to add, update, or remove. To remove a database, include its id and set _destroy: true.
object
An object containing detailed configuration options to update. Only the keys provided in this object will be modified, including inside components. For a full list of options, see the configuration object section in the Create collector API documentation. Send false in components to turn a component off. If you send the legacy metrics_databases without metrics_cluster, it can also set whichever of metrics_postgres, metrics_mysql, metrics_elasticsearch and metrics_pgbouncer you leave out, so send those four explicitly.
object
Rotates the key pair of the custom bucket the collector already uses. Send only access_key_id and secret_access_key. We verify the new pair against the bucket first; if that fails, the whole request is rejected with a 422 and nothing is changed. A bucket shared with other collectors or sources is rotated for all of them. Send the new pair before deactivating the old one to rotate without downtime.
integer
Custom retention period for logs, in days. This is only available on select plans.
integer
The ID of the resource group to assign the collector’s associated sources to. Send 0 or null to remove the assignment.
boolean
Set to true to pause data ingestion, or false to resume.
string
A custom format for messages displayed in live tail, with columns wrapped in {column} brackets. Example: "PID: {message_json.pid} {level} {message}". Send null to clear. For details, see Live tail docs.
integer
Custom retention period for metrics, in days. This is only available on select plans.
string
A custom Vector configuration in YAML format. Send null to remove.
string
A VRL program to be applied to logs server-side. Send null to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_COLLECTOR_METRIC_TARGET
Update a collector metrics target Updates an existing collector target. Only include the fields you want to change - omitted fields are preserved. [info] The kind field cannot be changed after creation. To switch to a different kind, remove the target and create a new one. [/info] [info] Changing any connection field resets the target’s status to pending so the collector can re-verify the connection. Connection fields are host, port, username, password, ssl_mode, tls, scheme, listen_ip, endpoint, api_key. [/info] PATCH /api/v1/collectors/{collector_id}/targets/{target_id} Requires a Telemetry API token with access to the resource.

Input Parameters

string ("false" | "true" | "skip-verify" | "preferred")
The TLS mode for the connection. Valid options are false, true, skip-verify, and preferred. Only for mysql.
string
The hostname or IP address of the target.
integer
The port number.
string ("http" | "https")
The connection scheme. Valid options are http and https. Only for elasticsearch.
string
An API key for authentication. Write-only - never returned in responses. Only for elasticsearch.
boolean
Set to false to disable the target, or true to re-enable it.
string
The service or container name.
string
The full scrape URL. Only for prometheus.
string
The password for authentication. Write-only - never returned in responses.
string ("disable" | "require" | "verify-ca")
The SSL mode for the connection. Valid options are disable, require, and verify-ca. Only for postgres.
string
The username for authentication.
string
The IP address the process listens on. Only for nginx, apache, kafka.
string
required
Identifier of the target.
string
required
Identifier of the collector.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_DASHBOARD
Update a dashboard Updates an existing dashboard by its ID. You only need to provide the fields you want to change. PATCH /api/v2/dashboards/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
The unique identifier of the dashboard to update.
string
A new name for the dashboard.
array
Array of variable objects. Custom variables missing from this array are removed; system variables are kept. Resend values for listed variables or their selection is cleared. Omitted variable_type, default_values, sql_definition, structured_value and allow_multiple_values are kept; null clears these except variable_type. Changing variable_type drops old default_values, sql_definition and structured_value.
string
A new end for the dashboard’s date range.
string
A new start for the dashboard’s date range.
integer
A new refresh interval in seconds.
integer
A new dashboard group ID. Use 0 or null to remove from a group.
string
A new SQL filter for source eligibility.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_DASHBOARD_ALERT
Update a dashboard alert Updates an existing alert on a dashboard chart. You only need to provide the fields you want to change. PATCH /api/v2/dashboards/{dashboard_id}/charts/{chart_id}/alerts/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the alert to update.
boolean
Enable SMS notifications. Only used if escalation_target is not a policy.
boolean
Enable phone call notifications. Only used if escalation_target is not a policy.
string
A new name for the alert.
boolean
Enable push notifications. Only used if escalation_target is not a policy.
boolean
Enable e-mail notifications. Only used if escalation_target is not a policy.
number
The numeric value for the alert condition. For threshold alerts, this is the static threshold. For relative alerts, this is the percentage change. Required for threshold and relative types unless string_value is set. A value of 0 is valid.
boolean
Whether the alert should be paused or active.
integer
required
The unique identifier of the chart.
object
A key-value object for custom metadata to be included in incidents. Both keys and values must be strings. This will replace all existing metadata.
string ("equal" | "not_equal" | "higher_than" | "higher_than_or_equal" | "lower_than" | "lower_than_or_equal" | "increases_by" | "decreases_by" | "changes_by")
The comparison operator. Required for threshold and relative alerts. For threshold: equal, not_equal, higher_than, higher_than_or_equal, lower_than, lower_than_or_equal. For relative: increases_by, decreases_by, changes_by. Not used for anomaly_rrcf alerts.
string ("threshold" | "relative" | "anomaly_rrcf")
The type of alert. threshold for static values, relative for percentage changes, or anomaly_rrcf for ML-based anomaly detection. Cannot be changed after creation.
string ("source_variable" | "platforms_single_source" | "platforms_all_sources")
The mode for source selection. Valid values: source_variable, platforms_single_source, platforms_all_sources.
integer
How often to evaluate the alert condition, in seconds. Required for threshold and relative alert types. Not used for anomaly_rrcf alerts.
integer
required
The unique identifier of the dashboard.
integer
The time window in seconds for the data being analyzed. If not provided, falls back to aggregation_interval, then check_period.
array
An array of strings to filter the alert to specific data series. Cannot be combined with series_names_except. Send an empty array to alert on any series.
string
An alternative to value for threshold alerts when matching an exact string. If string_value is set, value is not required. Only valid with equal or not_equal operators.
string
A custom name template for the incident created by this alert, in plain text. Supports the same variables as incident_cause, such as {{alert_name}} and {{series_name}}. When empty, the incident is named after the dashboard and the alert. Send null to clear it.
boolean
Enable critical push notifications that bypass Do Not Disturb. Only used if escalation_target is not a policy.
string
A custom description template for the incident created by this alert. Supports {{value}} placeholder.
string ("any" | "higher" | "lower")
Defines which anomalies trigger an alert: any (both higher and lower), higher, or lower. Only for anomaly_rrcf alerts.
string ("treat_as_zero" | "dont_fire" | "treat_as_previous" | "start_incident")
What to do when the query returns no data: treat_as_zero, dont_fire, treat_as_previous, or start_incident. Only for threshold and relative alerts. Default: dont_fire.
integer
The duration in seconds that a condition must be resolved before an incident is recovered. A value of 0 recovers the incident immediately, null means never automatically recover an incident.
string
The variable name for the source selection. If not provided, derived automatically from the dashboard preset’s source variable.
array
An array of platform names to filter the sources this alert runs on.
string
Defines where to send notifications. Defaults to current_team.
number
How far the value must deviate from its predicted value to trigger an alert, from 1 to 10. Higher values require a larger deviation and trigger fewer alerts. Shown as Significance in the app. Only for anomaly_rrcf alerts. Default: 5.
integer
The duration in seconds that a condition must be met before an alert is triggered. A value of 0 triggers the alert immediately.
boolean
Whether a separate incident will be created for each data series that triggers the alert.
array
An array of strings to alert on all data series except the listed ones. Cannot be combined with series_names.
integer
The size of data buckets in seconds for aggregating and evaluating the metric. If not provided, falls back to query_period, then check_period.
array
An array of up to 4 additional conditions, each combined with the primary condition using logical AND, so the alert only fires where every condition is breached in the same time bucket. Each condition is an object with an alert_type of threshold or relative, an operator, a value or string_value, and an optional series_names or series_names_except scope. Anomaly detection cannot be used as an additional condition. Send an empty array to clear all additional conditions. See Multiple conditions on the create page for an example.
integer
How many days of history the anomaly detection model is trained on, from 1 to 30. Only for anomaly_rrcf alerts. Default: 7.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_DASHBOARD_GROUP
Update a dashboard group Updates an existing dashboard group by its ID. PATCH /api/v2/dashboard-groups/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the dashboard group to update.
string
A new name for the dashboard group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_DASHBOARD_SECTION
Update a dashboard section Updates an existing section by its ID. You only need to provide the fields you want to change. PATCH /api/v2/dashboards/{dashboard_id}/sections/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the section to update.
string
A new name for the section.
boolean
A new collapsed state for the section.
string
A new explanation text for the section.
integer
required
The unique identifier of the dashboard.
integer
A new vertical position for the section.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_DATADOG_INTEGRATION
Update Datadog integration Update an existing Datadog integration. Send only the parameters you wish to change (eg. paused). PATCH /api/v2/datadog-integrations/{datadog_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

boolean
Send an SMS to the on-call person.
boolean
Call the on-call person.
string
The name of the Datadog integration that you can see in the dashboard.
boolean
Send a push notification to the on-call person.
boolean
Send an e-mail to the on-call person.
boolean
Set to true to pause the integration, false to unpause it.
string
ID of the escalation policy associated with the Datadog integration.
integer
How long we wait before escalating the incident alert to the team. In seconds.
string ("alert" | "alert_and_warn")
Should we alert only on alarms, or on both alarms and warnings. Possible values: alert, alert_and_warn. Defaults to alert.
boolean
Send a critical push notification that ignores the mute switch and Do not Disturb mode.
integer
Has no effect for this integration, since an incident resolves as soon as Datadog reports the alert as resolved.
string
required
The ID of the Datadog integration you want to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_ELASTIC_INTEGRATION
Update Elastic integration Update an existing Elastic integration. Send only the parameters you wish to change (eg. paused). PATCH /api/v2/elastic-integrations/{elastic_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

boolean
Send an SMS to the on-call person.
boolean
Call the on-call person.
string
The name of the Elastic integration that you can see in the dashboard.
boolean
Send a push notification to the on-call person.
boolean
Send an e-mail to the on-call person.
boolean
Set to true to pause the integration, false to unpause it.
string
ID of the escalation policy associated with the Elastic integration.
integer
How long we wait before escalating the incident alert to the team. In seconds.
boolean
Send a critical push notification that ignores the mute switch and Do not Disturb mode.
integer
Has no effect for this integration, since an incident resolves as soon as Elastic reports the alert as resolved.
string
required
The ID of the Elastic integration you want to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_EMAIL_INTEGRATIONUpdate an existing e-mail integration; send only fields you wish to change. Included rules and field configurations are replaced entirely, deleting previous entries. Send all entries to retain them; omit the attribute to leave it unchanged. Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

boolean
Send an SMS to the on-call person.
boolean
Call the on-call person.
string
The name of the e-mail integration that you can see in the dashboard.
boolean
Send a push notification to the on-call person.
boolean
Send an e-mail to the on-call person.
boolean
Set to true to pause the integration, false to unpause it.
string
ID of the escalation policy for incidents from this integration, or null to remove it. Without one, incidents alert the current on-call person through the channels set by call, sms, email, and push.
integer
How long we wait before escalating the incident to the team. In seconds. Send null to never escalate to the team, or 0 to alert the whole team right away.
object
How to extract the incident cause from the e-mail that starts an incident, as a field object with the keys below. Nested fields: cause_field.field_target: Which part of the e-mail to read: from_email, subject, or body.; cause_field.match_type: What to extract: match_everything takes the whole value, match_before the text before content, match_after the text after content, match_between the text between content_before and content_after, and match_regex the match of the regular expression in content, or its capture group.; cause_field.content: The text to extract around for match_before and match_after, or the regular expression for match_regex. Required for those three.; cause_field.content_before: Where extraction starts for match_between. Required for match_between.; cause_field.content_after: Where extraction stops for match_between. Leave it empty to extract to the end.
object
How to extract a custom incident title, as a field object with the same keys as cause_field. Send null to remove it and use the default title.
array
The conditions started_rule_type checks, as an array of rule objects with the keys below. At least one rule is required when the type is any or all. Nested fields: started_rules[].rule_target: Which part of the e-mail the rule checks: from_email, subject, or body.; started_rules[].match_type: How to compare the value with content: contains, contains_not, equals, equals_not, matches_regex, or matches_regex_not.; started_rules[].content: The value to compare with. Must be a valid regular expression for matches_regex and matches_regex_not.
boolean
Send a critical push notification that ignores the mute switch and Do Not Disturb mode.
array
The conditions resolved_rule_type checks, as rule objects with the same keys as started_rules.
integer
How long to wait after an e-mail matching resolved_rules arrives before marking an incident as resolved, in seconds: 0, 60, 180, 300, 900, 1800, 3600, or 7200. Has no effect while resolved_rule_type is unused.
string ("unused" | "any" | "all")
When e-mails start an incident: unused always, any when at least one of started_rules matches, or all when all of them match.
array
The conditions acknowledged_rule_type checks, as rule objects with the same keys as started_rules.
string ("unused" | "any" | "all")
When e-mails resolve an incident: unused never, any when at least one of resolved_rules matches, or all when all of them match. Any other value requires started_alert_id_field and resolved_alert_id_field.
string
required
The ID of the e-mail integration you want to update
array
Extra values to extract when an incident starts, saved as incident metadata. Each field object has the same keys as cause_field, plus name. Nested fields: other_started_fields[].name: The metadata key to save the extracted value under. Must be unique within the array.
array
Extra values to extract when an incident is resolved, with the same keys as other_started_fields.
string ("unused" | "any" | "all")
When e-mails acknowledge an incident: unused never, any when at least one of acknowledged_rules matches, or all when all of them match. Any other value requires started_alert_id_field and acknowledged_alert_id_field.
object
How to extract the alert ID from the e-mail that starts an incident, with the same keys as cause_field; later e-mails acknowledge and resolve the incident by matching it. Required when acknowledged_rule_type or resolved_rule_type isn’t unused.
object
How to extract the alert ID from an e-mail that resolves an incident, with the same keys as cause_field. Required when resolved_rule_type isn’t unused.
array
Extra values to extract when an incident is acknowledged, with the same keys as other_started_fields.
object
How to extract the alert ID from an e-mail that acknowledges an incident, with the same keys as cause_field. Required when acknowledged_rule_type isn’t unused.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_ESCALATION_POLICYTool to update an existing escalation policy. Use when you need to modify policy attributes like name, repeat settings, or escalation steps. Only the fields you provide will be updated (partial updates supported).

Input Parameters

string
The name of this escalation policy
array
An array of escalation policy steps to replace existing steps
string
required
The ID of the escalation policy to update
integer
How many times to repeat the escalation policy if unacknowledged
integer
How long in seconds to wait before each repetition

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_EXPLORATION
Update an exploration Updates an existing exploration by its ID. You only need to provide the fields you want to change. [info] When updating nested resources like queries or variables, the entire array will be replaced with the one you provide. [/info] PATCH /api/v2/explorations/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the exploration to update.
string
A new name for the exploration.
object
An object to update the chart’s configuration. The entire object is replaced.
array
An array of query objects to replace the existing queries.
array
An array of variable objects to replace the existing custom variables.
string
A new end for the exploration’s date range.
string
A new start for the exploration’s date range.
integer
A new exploration group ID. Use 0 or null to remove from a group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_EXPLORATION_ALERT
Update an exploration alert Updates an existing alert by its ID. You only need to provide the fields you want to change. PATCH /api/v2/explorations/{exploration_id}/alerts/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the alert to update.
boolean
Enable SMS notifications. Only used if escalation_target is not a policy.
boolean
Enable phone call notifications. Only used if escalation_target is not a policy.
string
A new name for the alert.
boolean
Enable push notifications. Only used if escalation_target is not a policy.
boolean
Enable e-mail notifications. Only used if escalation_target is not a policy.
number
The numeric value for the alert condition. For threshold alerts, this is the static threshold. For relative alerts, this is the percentage change. Required for threshold and relative types unless string_value is set. A value of 0 is valid.
boolean
Whether the alert should be paused or active.
object
A key-value object for custom metadata to be included in incidents. Both keys and values must be strings. This will replace all existing metadata.
string ("equal" | "not_equal" | "higher_than" | "higher_than_or_equal" | "lower_than" | "lower_than_or_equal" | "increases_by" | "decreases_by" | "changes_by")
The comparison operator. Required for threshold and relative alerts. For threshold: equal, not_equal, higher_than, higher_than_or_equal, lower_than, lower_than_or_equal. For relative: increases_by, decreases_by, changes_by. Not used for anomaly_rrcf alerts.
string ("threshold" | "relative" | "anomaly_rrcf")
The type of alert. threshold for static values, relative for percentage changes, or anomaly_rrcf for ML-based anomaly detection. Cannot be changed after creation.
string ("source_variable" | "platforms_single_source" | "platforms_all_sources")
The mode for source selection. Valid values: source_variable, platforms_single_source, platforms_all_sources.
integer
How often to evaluate the alert condition, in seconds. Required for threshold and relative alert types. Not used for anomaly_rrcf alerts.
integer
The time window in seconds for the data being analyzed. If not provided, falls back to aggregation_interval, then check_period.
array
An array of strings to filter the alert to specific data series. Cannot be combined with series_names_except. Send an empty array to alert on any series.
string
An alternative to value for threshold alerts when matching an exact string. If string_value is set, value is not required. Only valid with equal or not_equal operators.
string
A custom name template for the incident created by this alert, in plain text. Supports the same variables as incident_cause, such as {{alert_name}} and {{series_name}}. When empty, the incident is named after the exploration and the alert. Send null to clear it.
boolean
Enable critical push notifications that bypass Do Not Disturb. Only used if escalation_target is not a policy.
integer
required
The unique identifier of the exploration.
string
A custom description template for the incident created by this alert. Supports {{value}} placeholder.
string ("any" | "higher" | "lower")
Defines which anomalies trigger an alert: any (both higher and lower), higher, or lower. Only for anomaly_rrcf alerts.
string ("treat_as_zero" | "dont_fire" | "treat_as_previous" | "start_incident")
What to do when the query returns no data: treat_as_zero, dont_fire, treat_as_previous, or start_incident. Only for threshold and relative alerts. Default: dont_fire.
integer
The duration in seconds that a condition must be resolved before an incident is recovered. A value of 0 recovers the incident immediately, null means never automatically recover an incident.
string
The variable name for the source selection. If not provided, derived automatically from the exploration preset’s source variable.
array
An array of platform names to filter the sources this alert runs on.
string
Defines where to send notifications. Defaults to current_team.
number
How far the value must deviate from its predicted value to trigger an alert, from 1 to 10. Higher values require a larger deviation and trigger fewer alerts. Shown as Significance in the app. Only for anomaly_rrcf alerts. Default: 5.
integer
The duration in seconds that a condition must be met before an alert is triggered. A value of 0 triggers the alert immediately.
boolean
Whether a separate incident will be created for each data series that triggers the alert.
array
An array of strings to alert on all data series except the listed ones. Cannot be combined with series_names.
integer
The size of data buckets in seconds for aggregating and evaluating the metric. If not provided, falls back to query_period, then check_period.
array
An array of up to 4 additional conditions, each combined with the primary condition using logical AND, so the alert only fires where every condition is breached in the same time bucket. Each condition is an object with an alert_type of threshold or relative, an operator, a value or string_value, and an optional series_names or series_names_except scope. Anomaly detection cannot be used as an additional condition. Send an empty array to clear all additional conditions. See Multiple conditions on the create page for an example.
integer
How many days of history the anomaly detection model is trained on, from 1 to 30. Only for anomaly_rrcf alerts. Default: 7.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_EXPLORATION_GROUP
Update an exploration group Updates an existing exploration group by its ID. PATCH /api/v2/exploration-groups/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

integer
required
The unique identifier of the exploration group to update.
string
A new name for the exploration group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_GOOGLE_MONITORING_INTEGRATION
Update Google Monitoring integration Update an existing Google Monitoring integration. Send only the parameters you wish to change (eg. paused). PATCH /api/v2/google-monitoring-integrations/{google_monitoring_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

boolean
Send an SMS to the on-call person.
boolean
Call the on-call person.
string
The name of the Google Monitoring integration that you can see in the dashboard.
boolean
Send a push notification to the on-call person.
boolean
Send an e-mail to the on-call person.
boolean
Set to true to pause the integration, false to unpause it.
string
ID of the escalation policy associated with the Google Monitoring integration.
integer
How long we wait before escalating the incident alert to the team. In seconds.
boolean
Send a critical push notification that ignores the mute switch and Do not Disturb mode.
integer
Has no effect for this integration, since an incident resolves as soon as Google Monitoring reports the alert as resolved.
string
required
The ID of the Google Monitoring integration you want to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_GRAFANA_INTEGRATION
Update Grafana integration Update an existing Grafana integration. Send only the parameters you wish to change (eg. paused). PATCH /api/v2/grafana-integrations/{grafana_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

boolean
Send an SMS to the on-call person.
boolean
Call the on-call person.
string
The name of the Grafana integration that you can see in the dashboard.
boolean
Send a push notification to the on-call person.
boolean
Send an e-mail to the on-call person.
boolean
Set to true to pause the integration, false to unpause it.
string
ID of the escalation policy associated with the Grafana integration.
integer
How long we wait before escalating the incident alert to the team. In seconds.
boolean
Send a critical push notification that ignores the mute switch and Do not Disturb mode.
integer
Has no effect for this integration, since an incident resolves as soon as Grafana reports the alert as resolved.
string
required
The ID of the Grafana integration you want to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_HEARTBEATTool to update an existing heartbeat configuration. Use after retrieving a heartbeat and choosing which fields to change.

Input Parameters

boolean
Whether to send an SMS to the on-call person
boolean
Whether to call the on-call person on failure
string
The name of the service for this heartbeat
boolean
Whether to send a push notification on failure
boolean
Whether to send an email to the on-call person
integer
Acceptable delay beyond period in seconds (min 0)
boolean
Set true to pause monitoring; false to resume
integer
How often to expect the heartbeat in seconds (min 30)
string
ID of the escalation policy to assign
integer
Seconds to wait before escalating alert to team. Leave blank to disable team escalation.
integer
Index position within a heartbeat group
string
required
The ID of the heartbeat to update
boolean
Send a critical push ignoring mute and Do Not Disturb
string
End of maintenance window each day (HH:MM:SS)
array
Days for daily maintenance window. Use both days for overnight windows.
string
Start of maintenance window each day (HH:MM:SS)
string
ID of the heartbeat group to assign
string
Timezone for maintenance window. See Rails TimeZone list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_HEARTBEAT_GROUPUpdates an existing heartbeat group’s properties. Use to rename a group, change its display order, or pause/resume monitoring for all heartbeats in the group.

Input Parameters

string
New name for the heartbeat group visible in the dashboard.
boolean
Set to true to pause monitoring for all heartbeats in this group; false to resume monitoring.
integer
Zero-based index to control the display order of heartbeat groups in the dashboard.
string
required
The ID of the heartbeat group to update. Use list heartbeat groups to find available IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_INCIDENT_COMMENTTool to update an existing comment on an incident. Use when you need to modify the content of a comment that was previously added to a Better Stack incident.

Input Parameters

string
required
The updated content of the comment. Markdown is supported for formatting.
string
required
The ID of the comment to update
string
required
The ID of the incident containing the comment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_INCOMING_WEBHOOKUpdate an incoming webhook, sending only the fields to change. Included *_rules and *_fields collections replace their stored entries entirely; omit a collection to preserve its existing entries. Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

boolean
Send an SMS to the on-call person.
boolean
Call the on-call person.
string
The name of the incoming webhook that you can see in the dashboard.
boolean
Send a push notification to the on-call person.
boolean
Send an e-mail to the on-call person.
boolean
Set to true to pause the integration, false to unpause it.
string
ID of the escalation policy for incidents from this integration, or null to remove it. Without one, incidents alert the current on-call person through the channels set by call, sms, email, and push.
integer
How long we wait before escalating the incident to the team. In seconds. Send null to never escalate to the team, or 0 to alert the whole team right away.
object
Cause extraction object; without one incidents show Unknown cause. Required field_target: query_string, header, body, json, xml. target_field: dot path such as alert.id for json/query_string, header name for header, CSS selector for xml; unused for body. Required match_type: match_everything (whole value), match_before, match_after, match_between, match_regex (match or capture group). content is required for match_before/match_after (boundary text) and match_regex (regex). content_before and content_after are required for match_between.
object
How to extract a custom incident title, as a field object with the same keys as cause_field. Send null to remove it and use the default title.
array
The conditions started_rule_type checks, as an array of rule objects with the keys below. At least one rule is required when the type is any or all. Nested fields: started_rules[].rule_target: Which part of the request the rule checks: query_string, header, body, json, or xml.; started_rules[].target_field: Which value to read: a dot-separated path such as alert.id for json and query_string, a header name for header, or a CSS selector for xml. Not used with body.; started_rules[].match_type: How to compare the value with content: contains, contains_not, equals, equals_not, matches_regex, or matches_regex_not.; started_rules[].content: The value to compare with. Must be a valid regular expression for matches_regex and matches_regex_not.
boolean
Send a critical push notification that ignores the mute switch and Do Not Disturb mode.
array
The conditions resolved_rule_type checks, as rule objects with the same keys as started_rules.
integer
How long to wait after a request matching resolved_rules arrives before marking an incident as resolved, in seconds: 0, 60, 180, 300, 900, 1800, 3600, or 7200. Has no effect while resolved_rule_type is unused.
string ("unused" | "any" | "all")
When requests start an incident: unused always, any when at least one of started_rules matches, or all when all of them match.
array
The conditions acknowledged_rule_type checks, as rule objects with the same keys as started_rules.
string ("unused" | "any" | "all")
When requests resolve an incident: unused never, any when at least one of resolved_rules matches, or all when all of them match. Any other value requires started_alert_id_field and resolved_alert_id_field.
string
required
The ID of the incoming webhook you want to update
array
Extra values to extract when an incident starts, saved as incident metadata. Each field object has the same keys as cause_field, plus name. Nested fields: other_started_fields[].name: The metadata key to save the extracted value under. Must be unique within the array.
array
Extra values to extract when an incident is resolved, with the same keys as other_started_fields.
string ("unused" | "any" | "all")
When requests acknowledge an incident: unused never, any when at least one of acknowledged_rules matches, or all when all of them match. Any other value requires started_alert_id_field and acknowledged_alert_id_field.
object
How to extract the alert ID from the request that starts an incident, with the same keys as cause_field; later requests acknowledge and resolve the incident by matching it. Required when acknowledged_rule_type or resolved_rule_type isn’t unused.
object
How to extract the alert ID from a request that resolves an incident, with the same keys as cause_field. Required when resolved_rule_type isn’t unused.
array
Extra values to extract when an incident is acknowledged, with the same keys as other_started_fields.
object
How to extract the alert ID from a request that acknowledges an incident, with the same keys as cause_field. Required when acknowledged_rule_type isn’t unused.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_JIRA_INTEGRATION
Update Jira integration Update an existing Jira integration. Send only the parameters you wish to change (eg. name). PATCH /api/v2/jira-integrations/{jira_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
The name of the Jira integration that you can see in the dashboard.
object
Values for new Jira issues, keyed by Jira field ID. Most values are objects with value (Jira option ID) and label (display name); multi-value fields such as labels/components take arrays of these objects. Text fields take strings and number fields take numbers. Fetch the integration to use existing jira_fields as a template.
string
The key of the target Jira project, e.g. ABC for issues like ABC-123.
string
The ID of the target Jira issue type.
string
required
The ID of the Jira integration you want to update
boolean
Create a Jira issue every time an incident occurs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_METRIC
Update a metric Updates an existing metric or label. At least one of name, sql_expression, or aggregations must be provided. PATCH /api/v2/sources/{source_id}/metrics/{id} Requires a Telemetry API token with access to the resource.

Input Parameters

string
required
ID of the metric you want to update
string
Metric name
integer
required
Source for which to update a metric
string ("new_data" | "historical_logs")
How to process historical data. new_data (default) applies the change going forward. historical_logs reprocesses retained logs.
array
Aggregations to apply to the metric. Set to [] to change into a label.
Valid aggregations are avg, count, uniq, max, min, sum, and histogram
string
SQL expression to use for the metric

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_MONITORTool to update an existing uptime monitor configuration. Use when you need to modify settings of an existing monitor such as check frequency, notification preferences, URLs, or monitoring behavior.

Input Parameters

boolean
Enable SMS notifications when monitor goes down or recovers.
string
The URL or host to monitor. For HTTP/HTTPS monitors use full URL with protocol. For TCP/UDP/SMTP/POP/IMAP use hostname or IP. For DNS monitors use the domain to query.
boolean
Enable phone call alerts when monitor goes down or recovers.
string
Port number for TCP, UDP, SMTP, POP, or IMAP monitors. Required for these monitor types.
boolean
Enable push notifications to on-call personnel when monitor goes down or recovers.
boolean
Enable email notifications when monitor goes down or recovers.
boolean
If true, the monitor is paused and will not perform checks. If false, monitoring resumes.
array
List of regions from which to perform checks. Available: us (United States), eu (Europe), as (Asia), au (Australia).
string
ID of the escalation policy to use for this monitor. Controls who gets notified and in what order.
integer
Seconds to wait before escalating to the team after first notification. Leave blank to disable team escalation.
string ("ipv4" | "ipv6")
IP version to use for checks.
string
required
The ID of the monitor to update
boolean
Verify SSL certificates for HTTPS monitors. If false, monitors will accept invalid/self-signed certificates.
string ("GET" | "HEAD" | "POST" | "PUT" | "PATCH")
HTTP method for status/keyword monitors.
string ("status" | "expected_status_code" | "keyword" | "keyword_absence" | "ping" | "tcp" | "udp" | "smtp" | "pop" | "imap" | "dns" | "playwright")
Type of monitor to create or update.
string
Body content to send with POST/PUT/PATCH requests. Required for DNS monitors (specify the DNS record type to query).
string
Password for HTTP Basic Authentication. Used with auth_username.
string
Username for HTTP Basic Authentication. Used with auth_password.
string
Name identifier for playwright monitor scenarios. Used to distinguish between different automation scripts.
boolean
If enabled, alerts will override Do Not Disturb settings and mute schedules. Use for critical monitors only.
string
End time of daily maintenance window in HH:MM:SS format. Checks resume after this time.
integer
Advance warning in days before SSL certificate expiration. Allowed values: 1, 2, 3, 7, 14, 30, or 60.
integer
How often to check the monitor in seconds. Minimum is 30 seconds. Default is 30.
integer
Number of seconds the monitor must be up before automatically resolving any open incidents.
array
List of HTTP headers to send with the check request.
integer
Request timeout in milliseconds for server/port monitors or seconds for other types.
boolean
Automatically follow HTTP redirects when checking status/keyword monitors.
array
Days of the week to skip monitoring checks during maintenance windows. Combine with maintenance_from and maintenance_to.
string
Start time of daily maintenance window in HH:MM:SS format. Checks are skipped during this window on specified maintenance_days.
string
ID of the monitor group to assign this monitor to. Used for organizing monitors.
boolean
Whether to remember cookies across checks and redirects.
string
For keyword monitors: the text that must be present in the response. For keyword_absence monitors: the text that must NOT be present. Required for keyword and UDP monitor types.
integer
Advance warning in days before domain expiration. Allowed values: 1, 2, 3, 7, 14, 30, or 60.
string
JavaScript code for playwright monitor type. Defines browser automation scenario to execute during checks.
string
Human-readable name for the monitor displayed in the dashboard.
integer
How long in seconds to observe failures before creating an incident. Helps avoid false alerts from transient issues.
integer
ID of the escalation policy for SSL certificate and domain expiration alerts. Null sends email to team.
string
Timezone for maintenance window times. Use Rails TimeZone values. Defaults to UTC.
object
Key-value pairs of environment variables accessible within playwright scripts. Useful for parameterizing automation scenarios.
array
Array of acceptable HTTP status codes for successful checks. Used with expected_status_code monitor type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_MONITOR_GROUPUpdates an existing monitor group’s properties. Use to rename a group, change its display order, or pause/resume monitoring for all monitors in the group.

Input Parameters

string
Display name for the monitor group visible in the dashboard.
boolean
Set to true to pause monitoring for any existing monitors in the group; false to resume monitoring.
integer
Numeric value controlling monitor group sort order in the dashboard.
string
required
The ID of the monitor group to update. Use list monitor groups to find available IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_NEW_RELIC_INTEGRATION
Update New Relic integration Update an existing New Relic integration. Send only the parameters you wish to change (eg. paused). PATCH /api/v2/new-relic-integrations/{new_relic_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

boolean
Send an SMS to the on-call person.
boolean
Call the on-call person.
string
The name of the New Relic integration that you can see in the dashboard.
boolean
Send a push notification to the on-call person.
boolean
Send an e-mail to the on-call person.
boolean
Set to true to pause the integration, false to unpause it.
string
ID of the escalation policy associated with the New Relic integration.
integer
How long we wait before escalating the incident alert to the team. In seconds.
string ("alert" | "alert_and_warn")
Should we alert only on alarms, or on both alarms and warnings. Possible values: alert, alert_and_warn. Defaults to alert.
boolean
Send a critical push notification that ignores the mute switch and Do not Disturb mode.
integer
Has no effect for this integration, since an incident resolves as soon as New Relic reports the alert as resolved.
string
required
The ID of the New Relic integration you want to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_ON_CALL_EVENT
Update on-call schedule event Update a single event in the given on-call schedule. Events starting sooner than today at 0:00 UTC can’t be updated. PATCH /api/v2/on-calls/{schedule_id}/events/{event_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

array
List of e-mail addresses of the users that will be on-call during this event. Each user must be a member of the schedule’s team with a role that can respond to incidents, such as Responder.
string
End time of the event as an ISO 8601 timestamp.
string
required
The ID of the event you want to update.
boolean
Whether this event is an override. Override events take precedence over regular scheduled events.
string
Start time of the event as an ISO 8601 timestamp, e.g. 2025-01-01T09:45:00Z. Must be today at 0:00 UTC or later.
string
required
The ID of the on-call schedule that the event is part of. Use default to refer to the default on-call schedule for the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_ON_CALL_SCHEDULETool to update an on-call schedule’s name. Use when you need to rename an existing on-call calendar.

Input Parameters

string
required
The name of the schedule
string
required
The ID of the on-call schedule you want to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_OUTGOING_EMAIL
Update outgoing e-mail Updates an existing outgoing e-mail integration. Only the parameters you send are changed. Returns the updated integration, or validation errors. Sending recipients replaces the whole recipient list. PATCH /api/v2/outgoing-emails/{integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
The name of the outgoing e-mail integration that you can see in the dashboard.
array
Per-event message templates. See Create outgoing e-mail for the shape, variables, and replace semantics.
array
The addresses that receive incident e-mails. Each entry is either a plain e-mail string, or an object with an email key plus your own custom attribute keys. Replaces the whole recipient list when sent. See Create outgoing e-mail for the full shape.
string
required
The ID of the outgoing e-mail integration.
boolean
Whether to send an e-mail when a new comment is added to an incident. At least one of the on_incident_* triggers must stay enabled.
boolean
Whether to send an e-mail when an incident starts.
boolean
Whether to send an e-mail when an incident is reopened.
boolean
Whether to send an e-mail when an incident is resolved.
boolean
Whether to send an e-mail when an incident is acknowledged.
boolean
Whether to notify recipients alongside the primary responder when no escalation policy is configured.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_OUTGOING_WEBHOOKTool to update an existing outgoing webhook integration. Use when you need to modify the configuration of a webhook endpoint.

Input Parameters

string
Webhook destination URL
string
Integration display name
boolean
Trigger on incident creation
string
required
The ID of the Outgoing Webhook integration you want to update
boolean
Trigger when incident reopened
boolean
Trigger when incident resolved
boolean
Trigger when incident acknowledged
object
Custom webhook template attributes such as HTTP method, headers, and body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_PAGERDUTY_INTEGRATION
Update PagerDuty integration Update an existing PagerDuty integration. Send only the parameters you wish to change (eg. name). PATCH /api/v2/pager-duty-webhooks/{pager_duty_webhook_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
The PagerDuty routing key.
string
The name of the PagerDuty integration that you can see in the dashboard.
string ("info" | "warning" | "error" | "critical")
The severity of PagerDuty alerts created for new incidents. Possible values: info, warning, error, critical.
string
required
The ID of the PagerDuty integration you want to update.
boolean
Whether to notify this integration alongside the primary responder when no escalation policy is configured. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_POLICY_GROUPUpdates an existing escalation policy group’s properties. Use to rename a group or change its display order.

Input Parameters

string
New name for the escalation policy group visible in the dashboard.
integer
Zero-based index to control the display order of escalation policy groups in the dashboard.
string
required
The ID of the escalation policy group to update. Use list policy groups to find available IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_PROMETHEUS_INTEGRATION
Update Prometheus integration Update an existing Prometheus integration. Send only the parameters you wish to change (eg. paused). PATCH /api/v2/prometheus-integrations/{prometheus_integration_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

boolean
Send an SMS to the on-call person.
boolean
Call the on-call person.
string
The name of the Prometheus integration that you can see in the dashboard.
boolean
Send a push notification to the on-call person.
boolean
Send an e-mail to the on-call person.
boolean
Set to true to pause the integration, false to unpause it.
string
ID of the escalation policy associated with the Prometheus integration.
integer
How long we wait before escalating the incident alert to the team. In seconds.
boolean
Send a critical push notification that ignores the mute switch and Do not Disturb mode.
integer
Has no effect for this integration, since an incident resolves as soon as Prometheus reports the alert as resolved.
string
required
The ID of the Prometheus integration you want to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_SLACK_INTEGRATIONUpdate an existing Slack integration’s explicitly provided settings. Lists replace the whole list. Connect Slack in the Better Stack dashboard first.

Input Parameters

array
Replaces the teams and escalation policies Slack users can alert. A team is {"type": "team", "id": 7} with the booleans call, sms, email, push and critical_alert, each false when left out. An escalation policy is {"type": "policy", "id": 73}. The provider ignores read-only keys from GET (name, team_id, team_name), so GET options can be sent back unchanged.
boolean
Notify when a resource is paused.
boolean
Make the incident channels private. Needs at least one entry in channel_invitees.
array
Who to always invite into the incident channel when integration_type is channel. Replaces the whole list. Each object has a type and an id; type is user, on_call_calendar, or slack_user_group.
string ("verbose" | "thread" | "channel")
How incidents are posted. verbose posts every incident to the single connected channel, thread starts a thread per incident in it, and channel creates a new channel per incident. thread and channel need a paid plan.
boolean
Start an AI SRE conversation when Better Stack is tagged.
boolean
Notify when an incident is resolved.
string
The name shown for the connected channel in Better Stack. Send null to show the channel’s own name.
boolean
Post incident timeline events about e-mails, phone calls, and integrations. Applies when integration_type is thread or channel.
string
required
The ID of the Slack integration you want to update.
boolean
Notify the channel when the primary responder changes.
boolean
Invite new Slack users into your Better Stack team as responders.
boolean
Post incident metadata.
boolean
Post status page updates. Turning it off clears status_page_update_resources.
boolean
Send a direct message to people tagged in incident comments.
boolean
Let Slack users alert every team and escalation policy. Set it to false to allow only the ones in alert_options.
array
Replaces the affected resources for status page updates. Each object has a type and an id; an empty list posts updates for every resource of the integration’s team. Needs post_status_page_updates turned on.
boolean
Notify this integration alongside the primary responder when no escalation policy is configured.
boolean
Allow creating incidents only by the members of the connected channel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_SOURCE
Update a source Updates an existing source. Send only the parameters you wish to change (e.g. name ) PATCH /api/v2/sources/{source_id} Requires a Telemetry API token with access to the resource.

Input Parameters

string
Source name
string
required
Identifier of the source.
array
URLs to scrape by prometheus_scrape platform and similar.
string
For aws sources: CloudFormation IntegrationRoleArn. Send together with aws_external_id.
object
Rotates the key pair of the custom bucket the source already uses. Send only access_key_id and secret_access_key. We verify the new pair against the bucket first; if that fails, the whole request is rejected with a 422 and nothing is changed. A bucket shared by several sources is rotated for all of them. Send the new pair before deactivating the old one to rotate without downtime. A custom bucket can only be added when creating a source.
string
Link an already connected AWS account instead of sending aws_role_arn and aws_external_id.
string
Link an already connected Google Cloud project instead of sending gcp_project_id and gcp_project_number.
string
For gcp sources: Google Cloud project ID. Send together with gcp_project_number.
integer
Data retention for logs in days. There might be additional charges for longer retention.
string
For aws sources: CloudFormation ExternalId for STS assume-role trust. Send together with aws_role_arn.
array
Metric names to mark as spam. Listed metrics are rejected during ingestion and aren’t billed.
boolean
Whether to skip SSL/TLS certificate verification for prometheus_scrape platform and similar. Set to true to disable verification.
integer
The ID of the source group this source belongs to
boolean
Enable or disable ingesting for this source
string
Live tail message format with columns wrapped in {column} brackets. Example: "PID: {message_json.pid} {level} {message}". For details, see Live tail docs.
integer
Data retention for metrics in days. There might be additional charges for longer retention.
string
For gcp sources: Google Cloud project number. Send together with gcp_project_id.
integer ("15" | "30" | "60" | "120" | "300")
How often to scrape the URLs for prometheus_scrape platform and similar. Permitted values are 15, 30, 60, 120 or 300.
array
An array of request headers for prometheus_scrape platform and similar, with each object containing name and value fields.
boolean
Only for aws sources. Whether Better Stack automatically subscribes newly discovered Amazon CloudWatch log groups for ingestion. Defaults to true. Set to false to subscribe log groups yourself.
string
The VRL code applied to logs during ingestion. Send an empty string to remove the transformation, or null to reset it to the platform default. Read more about VRL transformations.
string
The VRL code applied to traces (spans) during ingestion. Send an empty string to remove the transformation. Read more about VRL transformations.
string
Basic auth username for prometheus_scrape platform and similar.
string
Basic auth password for prometheus_scrape platform and similar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_SOURCE_GROUPUpdate an existing source group in Better Stack Logs/Telemetry. Use this to rename a source group or change its sort order. Requires a Telemetry API token (different from Uptime API token).

Input Parameters

string
The new display name of the source group
integer
Order index to control group sorting. Must be non-negative.
string
required
The ID of the source group you want to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_SPLUNK_INTEGRATION
Update Splunk integration Update an existing Splunk On-Call integration. Send only the parameters you wish to change (eg. name). PATCH /api/v2/splunk-on-calls/{splunk_on_call_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
The Splunk On-Call URL to which to post webhooks to.
string
The name of the Splunk On-Call integration that you can see in the dashboard.
string
required
The ID of the Splunk On-Call integration you want to update.
boolean
Whether to notify this integration alongside the primary responder when no escalation policy is configured. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_STATUS_PAGE_GROUPTool to update an existing status page group. Use when you need to modify the name or display order of a status page group.

Input Parameters

string
A descriptive label for the group visible in the dashboard.
integer
Numeric value determining the group’s display order.
string
required
The ID of the status page group to update. Use list status page groups to find available IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_STATUS_PAGE_REPORTTool to update an existing status page report. Use when you need to modify the title, timing, or affected resources of an existing incident or maintenance report.

Input Parameters

string
The updated title/name for the status page report
string
ISO-8601 timestamp when the report concludes. Required for maintenance-type reports.
string
required
The numeric ID of the status report to update (e.g., ‘824282’).
string
ISO-8601 timestamp when the report becomes active. Defaults to current time if not provided.
string
required
The numeric ID of the status page (e.g., ‘221582’). Obtain this from the list_status_pages action.
array
List of status page resources affected by this report, with their status. Each object must contain status_page_resource_id and status fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_STATUS_PAGE_RESOURCETool to update an existing status page resource. Use when you need to modify the display name, position, widget type, or other properties of a resource on a status page.

Input Parameters

integer
Zero-indexed placement; unspecified defaults to end position
string
Helper text displayed as an icon
string
How the resource appears on your public status page
string
required
The specific resource requiring modification
string ("plain" | "history" | "response_times" | "chart_only")
Display format options: plain, history, response_times, or chart_only
string ("Monitor" | "MonitorGroup" | "Heartbeat" | "HeartbeatGroup" | "WebhookIntegration" | "EmailIntegration" | "IncomingWebhook" | "ResourceGroup" | "LogsChart" | "CatalogReference")
Type of resource on the status page
boolean
Boolean preventing position reordering when enabled
string
required
The identifier of your status page
string ("any_incident" | "no_incident" | "incident_matching_metadata")
Incident impact settings: any_incident, no_incident, or incident_matching_metadata
string ("any_incident" | "no_incident" | "incident_matching_metadata")
Degraded status trigger: any_incident, no_incident, or incident_matching_metadata
string
Section assignment (defaults to first section if omitted)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_STATUS_PAGESTool to update an existing status page configuration. Use when modifying settings like company info, appearance, access control, or display preferences.

Input Parameters

string ("light" | "dark" | "system")
Theme options for status pages (v2 only).
string ("v1" | "v2")
Design version options for status pages.
string ("vertical" | "horizontal")
Layout options for status pages (v2 only).
integer
Number of days to display on the status page. Between 7 and 365 days
string
URL of the logo image. Image should be under 20MB
string
Password for accessing the status page (when password_enabled is true)
string
Timezone in Rails TimeZone format
string
Subdomain for the status page. Must be globally unique
string
Custom CSS to apply to the status page
string
URL of the company homepage
string
URL for contact or support page
string
Announcement text to display on the status page
string
Company name shown on the status page
array
List of IP addresses allowed to access the page
boolean
Whether visitors can subscribe for updates
string
Custom domain for the status page
string
required
Identifier for the status page being modified
Custom navigation links for the status page
boolean
Whether a password is required to view the page
boolean
Whether automatic reports are enabled
string
Custom JavaScript to apply to the status page
string
Google Analytics tracking ID
integer
Minimum incident duration in seconds to be displayed
string
ID of the status page group to assign this page to
boolean
Whether the page should be hidden from search engines

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_STATUS_PAGE_SECTIONTool to update an existing status page section. Use when reorganizing sections or changing their display. Leave name blank to hide the section header.

Input Parameters

string
Section title. Omit to hide the header.
integer
Zero-indexed placement on the status page. Unspecified adds to end.
string
required
The section identifier you want to modify.
string
required
The identifier for your status page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_STATUS_PAGE_STATUS_REPORT_STATUS_UPDATETool to update an existing status update for a status report. Use when you need to modify the message, affected resources, or other details of a previously created status update.

Input Parameters

string
Message associated with the status update, providing details about the current state or actions taken.
string
ISO-8601 timestamp for publication time. If not provided, uses the original published time.
string
required
Your status page identifier. Obtain from list_status_pages action.
string
required
Your status page report identifier. Obtain from list_status_page_reports action.
string
required
Your status update identifier. Obtain from list_status_page_report_status_updates action.
array
Array of affected resources with their current status. If provided, must contain at least one resource.
boolean
Send notification email to subscribers. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_STATUS_PAGE_SUBSCRIBER
Update status page subscriber Updates which status page resources an e-mail subscriber receives notifications for. Only status_page_resource_ids can be changed. To change an e-mail address, remove the old subscriber and create a new one. PATCH /api/v2/status-pages/{status_page_id}/subscribers/{subscriber_id} Requires a Better Stack Incidents API token with access to the resource.

Input Parameters

string
required
The ID of the subscriber.
string
required
The ID of your status page.
array
required
The status page resources this subscriber receives updates for. Use [] for all resources. Each ID must be a resource of this status page other than a third party service. Get valid resource IDs from GET /api/v2/status-pages/{status_page_id}/resources.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_TEAM_MEMBER_ROLEChange an existing team member’s role using an ID from List roles. Supports custom roles, returned as role=custom. Requires a global API token with team_name, or a team-scoped Incidents API token. Changes to or from admin are forbidden; changes to or from billing_admin require a global token and apply across all the member’s teams. Pending invitations cannot use this operation. Assigning the current role returns the member unchanged (HTTP 200).

Input Parameters

string
required
The ID of the team member, as returned by the List or Get team members API. Pending invitations cannot have their role changed this way — cancel and re-invite them instead.
string
required
The ID of the role to assign, as returned by the List roles API. Custom roles are supported. The response returns role as custom for a custom role.
string
Required if using a global API token to specify the team. Ignored for team-scoped Incidents API tokens.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_URGENCIESUpdate a severity level (urgency) by ID, providing its name and SMS, call, email, and push notification settings.

Input Parameters

boolean
required
Enables SMS notifications for new incidents at this severity level
boolean
required
Enables phone calls for new incidents at this severity level
string
required
The identifier for this severity level
boolean
required
Enables push notifications for new incidents at this severity level
boolean
required
Enables email notifications for new incidents at this severity level
string
required
The ID of the severity level to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BETTER_STACK_UPDATE_URGENCY_GROUPTool to update an existing urgency group (severity group). Use when you need to modify the name or sort order of a severity group.

Input Parameters

string
The display name for the group visible in the dashboard.
integer
Determines the sorting order of the severity group. Must be non-negative.
string
required
The ID of the urgency group (severity group) to update. You can get this from the list urgency groups action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not