Skip to main content

FireHydrant Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a FireHydrant location.
fire_hydrant_api.png

FireHydrant

Create a FireHydrant Destination​

  1. Click the + icon on the Nexset that will be sent to the FireHydrant destination, and select the Send to Destination option from the menu.

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

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

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

Configure Using a Template​

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

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Create Incident

    Creates a new incident in FireHydrant using data from a Nexset. Use this endpoint to automatically open incidents based on events or alerts detected in other systems—for example, triggering a FireHydrant incident when a monitoring tool detects a threshold breach or when an anomaly is identified in a data pipeline.

    • This endpoint accepts incident data in JSON format. The Nexset fields will be mapped to the FireHydrant incident fields in the request body.

    • Common fields that can be included in the request body are:

      • name (required): The name or title of the incident.
      • description: A description of the incident.
      • severity: The severity level of the incident (e.g., SEV1, SEV2, SEV3).
      • priority: The priority of the incident.
      • tags: An array of tag names to apply to the incident.

    The request body is sent as JSON. Ensure that field names in the Nexset match the FireHydrant API field names. For the complete list of supported request body fields, refer to the FireHydrant Create Incident API documentation.

    Update Incident

    Updates an existing FireHydrant incident with new values for fields such as severity, status, summary, and tags. Use this endpoint to automatically keep FireHydrant incidents in sync with data from other systems—for example, updating an incident's severity when a monitoring metric changes, or closing an incident when a resolution is detected.

    • Id (required): Enter the unique ID of the FireHydrant incident to update. This is a UUID that identifies the specific incident record in FireHydrant. The incident ID can be obtained from the FireHydrant UI or from the output of the List Incidents source endpoint.

    • The request body should contain only the fields that need to be updated. Fields not included in the request body will remain unchanged on the incident.

    • Common fields that can be updated include:

      • severity: Update the incident severity level.
      • status: Update the current status of the incident.
      • description: Update the incident description or summary.
      • tags: Update the tags associated with the incident.

    This endpoint uses the HTTP PATCH method, which performs a partial update—only the fields included in the request body are changed. For the complete list of updatable fields, refer to the FireHydrant Update Incident API documentation.

    Create Change Event

    Creates a change event in FireHydrant representing a deployment, configuration change, or other modification to your infrastructure or services. Change events help teams correlate incidents with recent changes, enabling faster root cause analysis. Use this endpoint to automatically register change events from CI/CD pipelines, deployment tools, or configuration management systems.

    • This endpoint accepts change event data in JSON format. The Nexset fields will be mapped to the FireHydrant change event fields in the request body.

    • Common fields that can be included in the request body are:

      • summary (required): A brief summary of the change (e.g., Deployed v2.5.1 to production).
      • description: A detailed description of what changed.
      • labels: Key-value pairs providing additional metadata about the change (e.g., environment, version, or team).
      • services: An array of service identifiers indicating which services were affected by the change.

    Change events are a powerful tool for root cause analysis—FireHydrant surfaces recent change events on incident timelines to help responders identify potential causes. For the complete list of supported fields, refer to the FireHydrant Create Change Event API documentation.

    Add Incident Note

    Adds a timeline note or status update to an existing FireHydrant incident. Incident notes appear on the incident timeline and provide a chronological record of actions taken, observations made, and status updates communicated during the incident. Use this endpoint to automatically post status updates, log automated actions, or add contextual information from other systems to the incident timeline.

    • Id (required): Enter the unique ID of the FireHydrant incident to which the note will be added. The incident ID can be obtained from the FireHydrant UI or from the output of the List Incidents source endpoint.

    • The request body should include the note content. Common fields include:

    • body: The text content of the note to add to the incident timeline.

    For the complete list of supported request body fields, refer to the FireHydrant Create Incident Note API documentation.

    Create Ticket

    Creates a ticketing ticket in FireHydrant, optionally linked to an incident. Tickets represent follow-up action items, remediation tasks, or post-incident work items that need to be tracked to completion. Use this endpoint to automatically create follow-up tasks in FireHydrant based on data from other systems—for example, generating remediation tickets from a vulnerability scanner or task management workflow.

    • This endpoint accepts ticket data in JSON format. The Nexset fields will be mapped to the FireHydrant ticket fields in the request body.

    • Common fields that can be included in the request body are:

      • summary (required): A brief summary or title for the ticket.
      • description: A detailed description of the work to be done.

    For the complete list of supported request body fields, refer to the FireHydrant Create Ticket API documentation.

    Create Webhook

    Registers a new outbound webhook in FireHydrant. FireHydrant webhooks deliver real-time event notifications to an external URL when incident-related events occur, such as when an incident is created, updated, or resolved. Use this endpoint to programmatically register webhook endpoints in FireHydrant as part of an automated onboarding or integration setup workflow.

    • This endpoint accepts webhook configuration data in JSON format.

    • Common fields that can be included in the request body are:

      • url (required): The destination URL that FireHydrant will send event notifications to.
      • name: A descriptive name for the webhook.
      • state: The initial state of the webhook (active or inactive).

    For the complete list of supported request body fields, refer to the FireHydrant Create Webhook API documentation.

    Archive (Delete) Incident

    Archives (soft-deletes) an existing FireHydrant incident. When an incident is archived, it is hidden from the FireHydrant UI and excluded from analytics and reporting. Archiving is a non-destructive operation—archived incidents can be unarchived if needed. Use this endpoint to programmatically clean up test incidents, duplicate records, or incidents created in error.

    • Id (required): Enter the unique ID of the FireHydrant incident to archive. The incident ID can be obtained from the FireHydrant UI or from the output of the List Incidents source endpoint.

    Archiving an incident hides it from the UI and excludes it from analytics, but does not permanently delete it. Archived incidents can be restored using the FireHydrant Unarchive Incident API endpoint. For additional details, refer to the FireHydrant Archive Incident API documentation.

Configure Manually​

FireHydrant destinations can be manually configured to send data to any valid FireHydrant API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the FireHydrant API after each call to a new Nexla webhook data source.

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 destination, 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. Common methods for FireHydrant write operations include:

    • POST: For creating new resources (incidents, change events, tickets, webhooks, notes)
    • PATCH: For partially updating existing resources (updating incident fields)
    • DELETE: For archiving or removing resources

Data Format​

  1. Select the format in which the Nexset data will be sent to the FireHydrant API from the Content Format pulldown menu. FireHydrant accepts data as JSON. Nexla will automatically convert the Nexset data to JSON format for each API call.

API Endpoint URL​

  1. Enter the URL of the FireHydrant API endpoint to which you want to send the Nexset data in the URL field. For update and delete operations, include the ID of the resource to be updated or archived at the end of the URL (e.g., https://api.firehydrant.io/v1/incidents/{incident_id}).

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    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.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this FireHydrant destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

Property Inside JSON Object

  1. Enter the name of the JSON property that should contain the batched records in the Property Name field.
  2. If any additional properties should be included in the request, enter the properties in the Other Props field in JSON format.

Code

  1. Enter the code that will be used to create the batched request in the code editor below the Grouping Algorithm field.

Response Webhook​

Optional

Nexla can automatically send the response received from the FireHydrant API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call—for example, to capture the ID of a newly created incident for use in downstream processing.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the FireHydrant API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the FireHydrant API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the FireHydrant API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To begin sending data to the configured FireHydrant endpoint, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to FireHydrant until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.