> 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/firehydrant.md).

# FireHydrant

Declare and manage incidents, advance their lifecycle, and maintain the service catalog with FireHydrant.

### Connectors

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

| Connector   | Authentication |
| ----------- | -------------- |
| FireHydrant | API key        |

#### FireHydrant

Connect FireHydrant with a bot token to manage incidents and services.

**Set up in FireHydrant**

1. Prepare the FireHydrant account or service that the workflow will access. Grant access to the required resources and operations.
2. **API key:** Create a bot token in FireHydrant (Settings > Bot users), then paste it here. You need the Owner role to see the Bot users page. The token starts with 'fhb-' and grants everything the bot user's role allows.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **FireHydrant**.
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 key       | Yes      | Create a bot token in FireHydrant (Settings > Bot users), then paste it here. You need the Owner role to see the Bot users page. The token starts with 'fhb-' and grants everything the bot user's role allows. [Provider instructions](https://app.firehydrant.io/organizations/bots). |

#### 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 **FireHydrant** 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

#### List Incidents

Find FireHydrant incidents by text, severity, priority, current milestone, or creation time. Archived incidents appear only when you ask for them.

**Inputs**

| Field                        | Type            | Required | Description                                                                                                                           |
| ---------------------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| Search text                  | string          | No       | Only show incidents whose name, summary, or description contains this text.                                                           |
| Severity                     | select (string) | No       | Only show incidents with this severity. Options load from the selected connection.                                                    |
| Priority                     | select (string) | No       | Only show incidents with this priority. Options load from the selected connection.                                                    |
| Current milestone            | select (string) | No       | Only show incidents that are currently at this milestone, for example Started or Resolved. Options load from the selected connection. |
| Show advanced fields         | boolean         | No       | Reveal the creation-time window, archived incidents, page size, and page number. Default: false.                                      |
| Created after                | datetime        | No       | Only show incidents created at or after this date and time.                                                                           |
| Created before               | datetime        | No       | Only show incidents created at or before this date and time.                                                                          |
| Show archived incidents only | boolean         | No       | Turn on to list archived incidents instead of active ones. Default: false.                                                            |
| Incidents per page           | integer         | No       | How many incidents to return in one run, up to 200. Minimum: 1. Maximum: 200. Default: 20.                                            |
| Page                         | integer         | No       | Which page of results to return. Leave at 1 for the first page. Minimum: 1. Default: 1.                                               |

**Outputs**

| Field          | Type          | Description                                        |
| -------------- | ------------- | -------------------------------------------------- |
| Incidents      | object\_array | The incidents that match.                          |
| Total matching | integer       | How many incidents match in total.                 |
| Next page      | integer       | The next page number, if there are more incidents. |

#### Create Incident

Declare a new incident in FireHydrant with a name and optional severity, priority, summary, team, and tags. Only name is required; every other field can be set later in FireHydrant.

**Inputs**

| Field                | Type            | Required | Description                                                                                         |
| -------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------- |
| Incident name        | string          | Yes      | A short title for the incident.                                                                     |
| Summary              | textarea        | No       | A short summary of what is happening.                                                               |
| Severity             | select (string) | No       | How severe the incident is. Leave blank to set it later. Options load from the selected connection. |
| Priority             | select (string) | No       | How urgent the incident is. Leave blank to set it later. Options load from the selected connection. |
| Team                 | select (string) | No       | The team to assign to the incident. Options load from the selected connection.                      |
| Show advanced fields | boolean         | No       | Reveal the longer description and tags fields. Default: false.                                      |
| Description          | textarea        | No       | Longer details about the incident.                                                                  |
| Tags                 | string          | No       | Comma-separated tags to add to the incident.                                                        |

**Outputs**

| Field             | Type    | Description                               |
| ----------------- | ------- | ----------------------------------------- |
| Incident id       | string  | The new incident's id.                    |
| Incident number   | integer | The incident number shown in FireHydrant. |
| Incident name     | string  | The incident's title.                     |
| Severity          | string  | The incident's severity, if set.          |
| Priority          | string  | The incident's priority, if set.          |
| Current milestone | string  | The incident's starting milestone.        |
| Incident URL      | string  | Link to the incident in FireHydrant.      |

#### Update Incident Milestone

Move a FireHydrant incident to a milestone, for example Mitigated or Resolved, at a time you choose or now. Milestone times must stay in the order your organization configured.

**Inputs**

| Field     | Type            | Required | Description                                                                      |
| --------- | --------------- | -------- | -------------------------------------------------------------------------------- |
| Incident  | select (string) | Yes      | The incident to update. Options load from the selected connection.               |
| Milestone | select (string) | Yes      | The milestone to set on the incident. Options load from the selected connection. |
| Time      | datetime        | No       | When the milestone happened. Leave blank to use the current time.                |

**Outputs**

| Field       | Type          | Description                                 |
| ----------- | ------------- | ------------------------------------------- |
| Milestones  | object\_array | The incident's milestones with their times. |
| Incident id | string        | The incident that was updated.              |
| Milestone   | string        | The milestone that was set.                 |

#### Add Incident Note

Add a note to a FireHydrant incident's timeline. The note is visible only inside your organization and is not posted to status pages. Leave the time blank to use the current time.

**Inputs**

| Field                | Type            | Required | Description                                                                 |
| -------------------- | --------------- | -------- | --------------------------------------------------------------------------- |
| Incident             | select (string) | Yes      | The incident to add the note to. Options load from the selected connection. |
| Note                 | textarea        | Yes      | The text of the note.                                                       |
| Show advanced fields | boolean         | No       | Reveal the note's timeline time. Default: false.                            |
| Time                 | datetime        | No       | When the note's event happened. Leave blank to use the current time.        |

**Outputs**

| Field       | Type   | Description                         |
| ----------- | ------ | ----------------------------------- |
| Note id     | string | The new note's id.                  |
| Note        | string | The note text as saved.             |
| Created at  | string | When the note was saved.            |
| Incident id | string | The incident the note was added to. |

#### Create Service

Add a service to your FireHydrant service catalog, with an optional description, tier, and owning team. Leave tier blank to use FireHydrant's default of 5 (least critical).

**Inputs**

| Field        | Type             | Required | Description                                                                                                                                                                                                  |
| ------------ | ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Service name | string           | Yes      | The name of the service.                                                                                                                                                                                     |
| Description  | textarea         | No       | What the service does.                                                                                                                                                                                       |
| Tier         | select (integer) | No       | How critical the service is, from 1 (most critical) to 5 (least). Leave blank for tier 5. Available values: Tier 1 (most critical), Tier 2, Tier 3, Tier 4, Tier 5 (least critical). Minimum: 1. Maximum: 5. |
| Owning team  | select (string)  | No       | The team that owns the service. Options load from the selected connection.                                                                                                                                   |

**Outputs**

| Field          | Type    | Description                      |
| -------------- | ------- | -------------------------------- |
| Service id     | string  | The new service's id.            |
| Service name   | string  | The service's name as saved.     |
| Slug           | string  | The service's short identifier.  |
| Tier           | integer | The saved tier.                  |
| Owning team id | string  | The owning team, if one was set. |

### 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/firehydrant.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.
