> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/better-stack.md).

# Better Stack

Monitor services, manage incidents, and send heartbeat check-ins.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector    | Authentication |
| ------------ | -------------- |
| Better Stack | API token      |

#### Better Stack

Connect Better Stack Uptime and On-call with an API token.

**Set up in Better Stack**

1. Prepare the Better Stack account or service that the workflow will access. Grant access to the required resources and operations.
2. **API token:** Create an Uptime API token in Better Stack. A team-scoped token is preferred.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Better Stack**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                                    |
| ------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API token     | Yes      | Create an Uptime API token in Better Stack. A team-scoped token is preferred. [Provider instructions](https://betterstack.com/docs/uptime/api/getting-started-with-uptime-api/). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Better Stack** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create Monitor

Create an uptime check for a website or host.

**Inputs**

| Field               | Type             | Required | Description                                                                                                                                                                                                                                                    |
| ------------------- | ---------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Website URL or host | string           | Yes      | Address to check.                                                                                                                                                                                                                                              |
| Monitor name        | string           | Yes      | Name shown in Better Stack.                                                                                                                                                                                                                                    |
| Check type          | select (string)  | No       | What the monitor should check. Available values: Status, Expected status code, Keyword present, Keyword absent, Ping, TCP. Default: status.                                                                                                                    |
| Check every         | select (integer) | No       | How often Better Stack checks the target. Free plans require at least 3 minutes; shorter intervals require a paid plan. Available values: 30 seconds, 45 seconds, 1 minute, 2 minutes, 3 minutes, 5 minutes, 10 minutes, 15 minutes, 30 minutes. Default: 180. |
| Team name           | string           | No       | Owning team when using a global API token.                                                                                                                                                                                                                     |
| Expected keyword    | string           | No       | Text to find or exclude on the page.                                                                                                                                                                                                                           |
| Expected HTTP codes | string           | No       | Comma-separated codes that count as healthy.                                                                                                                                                                                                                   |
| TCP port            | integer          | No       | Port to check for TCP monitors.                                                                                                                                                                                                                                |
| Email alerts        | boolean          | No       | Send email alerts on failures. Default: true.                                                                                                                                                                                                                  |
| SMS alerts          | boolean          | No       | Send text message alerts on failures. Default: false.                                                                                                                                                                                                          |
| Phone alerts        | boolean          | No       | Call the on-call person on failures. Default: false.                                                                                                                                                                                                           |
| Push alerts         | boolean          | No       | Send push notifications on failures. Default: false.                                                                                                                                                                                                           |

**Outputs**

| Field        | Type   | Description              |
| ------------ | ------ | ------------------------ |
| Monitor ID   | string | ID of the new monitor.   |
| Monitor name | string | Name of the new monitor. |
| Status       | string | Current monitor status.  |

#### List Monitors

Find monitors and their current status.

**Inputs**

| Field        | Type    | Required | Description                                                                      |
| ------------ | ------- | -------- | -------------------------------------------------------------------------------- |
| Team name    | string  | No       | Show monitors owned by this team.                                                |
| Website URL  | string  | No       | Filter by monitored URL.                                                         |
| Monitor name | string  | No       | Filter by monitor name.                                                          |
| Page         | integer | No       | Page to start from. Minimum: 1. Default: 1.                                      |
| Limit        | integer | No       | Maximum monitors to return on this page. Minimum: 1. Maximum: 250. Default: 100. |

**Outputs**

| Field     | Type          | Description                                  |
| --------- | ------------- | -------------------------------------------- |
| Monitors  | object\_array | Monitors with their names, URLs, and status. |
| Next page | integer       | Page to request if more monitors remain.     |

#### Create Incident

Open an incident and notify on-call responders.

**Inputs**

| Field           | Type     | Required | Description                                           |
| --------------- | -------- | -------- | ----------------------------------------------------- |
| Summary         | string   | Yes      | Short description of the incident.                    |
| Requester email | string   | Yes      | Email address of the person reporting this incident.  |
| Incident name   | string   | No       | Title shown in Better Stack. Defaults to the summary. |
| Description     | textarea | No       | Details for responders.                               |
| Team name       | string   | No       | Owning team when using a global API token.            |
| Phone alerts    | boolean  | No       | Call the on-call responder.                           |
| SMS alerts      | boolean  | No       | Send an SMS alert.                                    |
| Email alerts    | boolean  | No       | Send an email alert.                                  |
| Push alerts     | boolean  | No       | Send a push alert.                                    |

**Outputs**

| Field       | Type     | Description              |
| ----------- | -------- | ------------------------ |
| Incident ID | string   | ID of the new incident.  |
| Started at  | datetime | When the incident began. |

#### Resolve Incident

Mark an ongoing incident as resolved.

**Inputs**

| Field                        | Type            | Required | Description                                                                      |
| ---------------------------- | --------------- | -------- | -------------------------------------------------------------------------------- |
| Incident ID                  | select (string) | Yes      | Choose an active incident to resolve. Options load from the selected connection. |
| Resolver email or identifier | string          | No       | Email or custom identifier of the resolver.                                      |

**Outputs**

| Field       | Type     | Description                                  |
| ----------- | -------- | -------------------------------------------- |
| Incident ID | string   | Resolved incident ID.                        |
| Resolved at | datetime | When the incident was resolved, if returned. |

#### Send Heartbeat

Record a successful check-in for a heartbeat.

**Inputs**

| Field        | Type            | Required | Description                                                                  |
| ------------ | --------------- | -------- | ---------------------------------------------------------------------------- |
| Heartbeat ID | select (string) | Yes      | Choose the heartbeat to check in. Options load from the selected connection. |

**Outputs**

| Field        | Type    | Description                    |
| ------------ | ------- | ------------------------------ |
| Heartbeat ID | string  | Heartbeat checked in.          |
| Sent         | boolean | Whether the check-in was sent. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/better-stack.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
