Cortex connects to many third-party vendors whose system interfaces frequently change. As a result, integration behavior or configuration steps may shift without notice. If you encounter unexpected issues, check with your system administrator or refer to the vendor’s documentation for the most current information. Additionally, integration sync times vary and are subject to scheduling overrides and timing variance.
- View incidents on entity pages in Cortex, giving you insight into incidents to act on them quickly
- Trigger new incidents directly from Cortex
- Create Scorecards to set standards around incident management and production readiness
How to integrate FireHydrant with Cortex
Prerequisites
Before getting started:- Create a FireHydrant API key.
Configure the integration in Cortex
- In Cortex, navigate to the FireHydrant settings page:
- Click Integrations from the main nav. Search for and select FireHydrant.
- Click Add configuration.
- Configure the integration:
- API key: Enter the API key you created in FireHydrant.
- Click Save.
How to connect Cortex entities to FireHyrant projects
Editing the entity descriptor
You can define FireHydrant services in an entity’s YAML file. For a given entity, define FireHydrant services by ID or slug. Each of these has the same field definitions.https://app.firehydrant.io/catalog/services/{ID}/incidents).
If you prefer to use the service slug in the registration instead, you can find it on the right-hand side of the service page in FireHydrant.
Using the FireHydrant integration
Viewing FireHydrant incidents on an entity
When active incidents are detected in FireHydrant, Cortex will display incident information on an entity’s details page. Click On-call & incidents in the entity’s sidebar to see all detected incidents. Each issue will be listed with its title and description (when available). Cortex will also display the status for an issue as a badge next to its name:AcknowledgedClosedDetectedIdentifiedInvestigatingMitigatedPostmortem completedPostmortem startedResolvedStarted
SEV0, SEV1, SEV2).
Trigger an incident
While viewing an entity in Cortex, you can trigger an incident in FireHydrant:- In Cortex, navigate to an entity. On the left side of an entity details page, click On-call & incidents.
- In the upper right side of the entity’s “On-call” page, click Trigger incident.
- Configure the incident modal:
- Summary: Enter a title for the incident.
- Description: Enter a description of the incident.
- Severity: Select a severity level.
- Condition: Nature of the incident -
Unavailable,Partially Unavailable,Degraded,Bug, orOperational.
- At the bottom of the modal, click Trigger incident.
- A confirmation screen will appear. In the confirmation, click the link to view the incident in FireHydrant.
Scorecards and CQL
With the FireHydrant integration, you can create Scorecard rules and write CQL queries based on FireHydrant incidents. See more examples in the CQL Explorer in Cortex.Check if FireHydrant service is set
Check if FireHydrant service is set
Check if entity has a registered FireHydrant service in its entity descriptor. If no registration exists, we’ll try to automatically detect which corresponding FireHydrant service is associated with the entity.Definition: This is also a good way to make sure over time that FireHydrant is set up properly and reporting frequently.
firehydrant (==/!=) nullExampleFor a Scorecard focused an production readiness, you can use this expression to make sure a FireHydrant service - and thus incident response - is defined for entities:Incidents
Incidents
List of incidents, filterable on severity and status.You can also tier severity-based rules to indicate progress over time. While the above rule might make sense in the first or second level, a higher-severity rule might make sense in a higher level:
- Created at
- Description
- Impact condition name
- Name
- Severity
- Status
firehydrant.incidents()ExamplesFor a Scorecard focused on service maturity or quality, you can use this expression to make sure there are no detected or identified FireHydrant incidents with a severity rating of 1 for a given entity:View integration logs
This feature is available in Cortex cloud.

Still need help?↗
The following options are available to get assistance from the Cortex Customer Engineering team:- Email: help@cortex.io, or open a support ticket in the in app Resource Center
- Slack: Users with a connected Slack channel will have a workflow added to their account. From here, you can either @CortexTechnicalSupport or add a
:ticket:reaction to a question in Slack, and the team will respond directly.