Skip to main content

FireHydrant Data Source

The FireHydrant connector enables you to ingest incident management data—including incidents, alerts, services, teams, runbooks, and operational metrics—directly into Nexla for analysis, reporting, and integration with downstream systems. Follow the instructions below to create a new data flow that ingests data from a FireHydrant source in Nexla.
fire_hydrant_api.png

FireHydrant

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the FireHydrant connector tile from the list of available connectors. Then, select the credential that will be used to connect to the FireHydrant instance, and click Next; or, create a new FireHydrant credential for use in this flow.

  3. In Nexla, FireHydrant data sources can be created using pre-built endpoint templates, which expedite source setup for common FireHydrant endpoints. Each template is designed specifically for the corresponding FireHydrant API endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    FireHydrant sources can also be configured manually, allowing you to ingest data from FireHydrant endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common FireHydrant endpoints. Each template is designed specifically for the corresponding FireHydrant API endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

List Incidents

Retrieves a list of incidents from your FireHydrant account, with optional filtering by search term, status, severity, tags, milestones, environments, and services. Use this endpoint to pull incident records into Nexla for analysis, reporting, or integration with downstream data platforms.

  • This endpoint supports several optional filter parameters. Configure any of the following fields to narrow the results returned:

  • Query (optional): Enter a search term to filter incidents by keyword. Leave blank to retrieve all incidents.

  • Status (optional): Enter an incident status value to filter results. Common FireHydrant status values include open, closed, and investigating. Leave blank to retrieve incidents in all statuses.

  • Severity (optional): Enter a severity level to filter incidents. FireHydrant severity values are typically defined by your organization (for example, SEV1, SEV2, SEV3). Leave blank to retrieve incidents at all severity levels.

  • Tag (optional): Enter a tag name to filter incidents by associated tag. Leave blank to retrieve incidents regardless of tag.

  • Current Milestones (optional): Enter a milestone value to filter incidents by their current milestone status (for example, started, detected, mitigated, resolved, or postmortem_completed). Leave blank to retrieve incidents at any milestone.

  • Environments (optional): Enter an environment name or ID to filter incidents associated with a specific environment. Leave blank to retrieve incidents across all environments.

  • Services (optional): Enter a service name or ID to filter incidents affecting a specific service. Leave blank to retrieve incidents across all services.

This endpoint uses page-based pagination and retrieves up to 200 records per page. For accounts with large numbers of incidents, Nexla will automatically paginate through all available results. For additional details about available filter parameters, refer to the FireHydrant List Incidents API documentation.

Get Incident by ID

Fetches the full details of a single FireHydrant incident by its unique identifier. Use this endpoint when you need complete incident data for a specific event—such as for post-incident reporting, audit trails, or downstream processing.

  • Id (required): Enter the unique ID of the incident to retrieve. FireHydrant incident IDs are UUIDs and can be found in the FireHydrant UI on the incident detail page, or by first using the List Incidents endpoint to retrieve a list of incidents and their corresponding IDs.

For additional details, refer to the FireHydrant Get Incident API documentation.

List Alerts

Returns a paginated list of alerts received by FireHydrant. Alerts are signals from monitoring tools and integrations that may trigger or be associated with incidents. Use this endpoint to analyze alert volume, frequency, and correlation with incidents.

  • This endpoint does not require any additional configuration. It automatically retrieves all alerts accessible to your FireHydrant organization.
  • The endpoint uses offset-based pagination and retrieves up to 200 records per page. Nexla will automatically paginate through all available results.

For additional details, refer to the FireHydrant List Alerts API documentation.

List Services

Returns the services registered in your FireHydrant service catalog. The service catalog is central to FireHydrant's incident management approach, tracking ownership, dependencies, and relationships between infrastructure components. Use this endpoint to export your service catalog data for analysis, reporting, or synchronization with other systems.

  • This endpoint does not require any additional configuration. It retrieves all services from the FireHydrant service catalog accessible to your account.

For additional details, refer to the FireHydrant List Services API documentation.

List Teams

Returns a list of teams and on-call responders configured in your FireHydrant account. Use this endpoint to export team structures, on-call schedules, and responder assignments for reporting or integration with HR and workforce management systems.

  • This endpoint does not require any additional configuration. It retrieves all teams accessible to your FireHydrant organization.

For additional details, refer to the FireHydrant List Teams API documentation.

List Environments

Returns a list of environments defined in your FireHydrant service catalog. Environments represent the deployment targets (such as production, staging, and development) that your services run in. Use this endpoint to export environment data for reporting or to cross-reference incident impact with specific deployment environments.

  • This endpoint does not require any additional configuration. It retrieves all environments accessible to your FireHydrant organization.

For additional details, refer to the FireHydrant List Environments API documentation.

List Runbooks

Returns a list of runbooks configured in your FireHydrant account. Runbooks are automated playbooks that define the steps and actions taken during an incident. Use this endpoint to audit your runbook library, export runbook definitions for documentation, or synchronize runbook metadata with external systems.

  • This endpoint does not require any additional configuration. It retrieves all runbooks accessible to your FireHydrant organization.

For additional details, refer to the FireHydrant List Runbooks API documentation.

Get Mean Time Reports

Returns mean time to detection (MTTD) and mean time to resolution (MTTR) metrics for incidents in your FireHydrant account. These metrics are key indicators of incident response efficiency and are commonly used for SRE performance reporting and continuous improvement tracking.

  • This endpoint does not require any additional configuration. It retrieves aggregate mean time metrics across incidents in your FireHydrant organization.

MTTD and MTTR metrics are calculated by FireHydrant based on incident milestone timestamps. For additional details, refer to the FireHydrant Mean Time Report API documentation.

List Tickets

Returns a paginated list of ticketing tickets from your FireHydrant account. FireHydrant's ticketing feature allows teams to create and track follow-up action items and tasks linked to incidents. Use this endpoint to export ticket data for project management reporting or integration with external ticketing systems.

  • This endpoint does not require any additional configuration. Nexla will automatically paginate through all available results, retrieving up to 200 records per page.

For additional details, refer to the FireHydrant List Tickets API documentation.

List Task Lists

Returns a paginated list of task lists from your FireHydrant account. Task lists are reusable collections of tasks that can be applied to incidents during response. Use this endpoint to export task list definitions for documentation or to analyze task assignment patterns across incidents.

  • This endpoint does not require any additional configuration. Nexla will automatically paginate through all available results, retrieving up to 200 records per page.

For additional details, refer to the FireHydrant List Task Lists API documentation.

List Checklist Templates

Returns a paginated list of checklist templates defined in your FireHydrant account. Checklist templates define the standard steps and verification items used during incident response. Use this endpoint to export checklist template definitions for auditing, documentation, or compliance reporting.

  • This endpoint does not require any additional configuration. Nexla will automatically paginate through all available results, retrieving up to 200 records per page.

For additional details, refer to the FireHydrant List Checklist Templates API documentation.

List Webhooks

Returns a list of all outbound webhooks configured in your FireHydrant account. FireHydrant webhooks deliver real-time event notifications to external URLs when incident-related events occur. Use this endpoint to audit your webhook configurations or export webhook definitions for documentation.

  • This endpoint does not require any additional configuration. It retrieves all webhooks configured in your FireHydrant organization.

For additional details, refer to the FireHydrant List Webhooks API documentation.

List Incident Roles

Returns a list of all incident roles available in your FireHydrant account. Incident roles (such as Incident Commander, Communications Lead, and Subject Matter Expert) define the responsibilities assigned to responders during an incident. Use this endpoint to export role definitions for documentation or workforce planning.

  • This endpoint does not require any additional configuration. It retrieves all incident roles defined in your FireHydrant organization.

For additional details, refer to the FireHydrant List Incident Roles API documentation.

List Incident Tags

Returns a list of all incident tags available in your FireHydrant account. Tags are used to categorize and filter incidents by topic, team, or other organizational criteria. Use this endpoint to export your tag taxonomy for documentation, reporting, or governance purposes.

  • This endpoint does not require any additional configuration. It retrieves all tags defined in your FireHydrant organization.

For additional details, refer to the FireHydrant List Incident Tags API documentation.

List Incident Types

Returns a list of all incident types available in your FireHydrant account. Incident types classify incidents by category (such as security, infrastructure, or application), enabling consistent categorization and filtering across your incident history.

  • This endpoint does not require any additional configuration. It retrieves all incident types defined in your FireHydrant organization.

For additional details, refer to the FireHydrant List Incident Types API documentation.

List Infrastructures

Returns a list of infrastructure components tracked in your FireHydrant account. Infrastructure components represent the systems, services, and dependencies that your organization monitors. Use this endpoint to export your infrastructure inventory for CMDB synchronization, reporting, or dependency analysis.

  • This endpoint does not require any additional configuration. It retrieves all infrastructure components registered in your FireHydrant organization.

For additional details, refer to the FireHydrant List Infrastructures API documentation.

List Custom Field Definitions

Returns a list of custom field definitions configured in your FireHydrant account. Custom fields extend FireHydrant's incident data model to capture organization-specific information. Use this endpoint to export your custom field schema for documentation, governance, or downstream data mapping purposes.

  • This endpoint does not require any additional configuration. It retrieves all custom field definitions available in your FireHydrant organization.

List Entitlements

Returns a list of entitlements configured in your FireHydrant account. Entitlements define the features and capabilities enabled for your organization based on your subscription plan. Use this endpoint to audit account entitlements or verify feature availability programmatically.

  • This endpoint does not require any additional configuration. It retrieves all entitlements configured for your FireHydrant organization.

For additional details, refer to the FireHydrant List Entitlements API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

FireHydrant data sources can be manually configured to ingest data from any valid FireHydrant API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex FireHydrant sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom request parameters.

The FireHydrant REST API base URL is https://api.firehydrant.io/v1. If your organization uses FireHydrant's EU region, replace api.firehydrant.io with api.eu.firehydrant.io in all endpoint URLs. For complete API reference documentation, see the FireHydrant API documentation.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the FireHydrant API from the Method pulldown menu. The most common method for retrieving data from FireHydrant is:

    • GET: For retrieving data from the API (used by all FireHydrant read endpoints)

API Endpoint URL​

  1. Enter the URL of the FireHydrant API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements. This is particularly useful for FireHydrant endpoints that support date-range filtering parameters.

Macros are particularly useful for APIs that require date ranges, pagination parameters, or other dynamic values that change between data ingestion runs.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are useful when you need to create API endpoints that reference specific FireHydrant IDs—such as incident IDs, service IDs, or team IDs—from other data sources in your Nexla environment.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data that will be returned by the API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful when FireHydrant API responses contain pagination metadata or other wrapper data that you don't need for your analysis.

For example, most FireHydrant list endpoints return an array of records inside a top-level data property alongside pagination metadata. By entering the path to the relevant data, you can configure Nexla to treat each element of the returned array as a record.

Path to Data is essential when API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.data.items[*] to access an array of items within a data object).

    • For responses in XML format, enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g., /response/data/item to access item elements within a data element).

    Path to Data Example:

    Most FireHydrant list endpoints return records inside a top-level data array. For these endpoints, the path to the response data would be entered as $.data[*].

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but isn't part of the main data array.

For example, FireHydrant list endpoints typically return an array of records inside a data property alongside pagination metadata (such as pagination.count, pagination.page, and pagination.pages). If you have specified $.data[*] as the path to relevant data, you can additionally specify the path to pagination metadata to include it with each record.

Metadata paths are particularly useful for preserving API response context like pagination details, request timestamps, or summary statistics that apply to all records in the response.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata, and for responses in XML format, enter the XPath.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers are sometimes required for API versioning or content type specifications.

    You do not need to include the Authorization header or any other headers already present in the FireHydrant credential. The Bearer token authentication header is automatically applied by Nexla based on your credential configuration.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new FireHydrant data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.