KosmoKrator

productivity

FireHydrant Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the FireHydrant KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.firehydrant.*. Use lua_read_doc("integrations.firehydrant") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic FireHydrant workflow without starting an interactive agent session.

Inline Lua call
kosmo integrations:lua --eval 'dump(app.integrations.firehydrant.check_api_connectivity({}))' --json
Read Lua docs headlessly
kosmo integrations:lua --eval 'print(docs.read("firehydrant"))' --json
kosmo integrations:lua --eval 'print(docs.read("firehydrant.check_api_connectivity"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua
local firehydrant = app.integrations.firehydrant
local result = firehydrant.check_api_connectivity({})

dump(result)
Run the workflow
kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json
Namespace note. integrations:lua exposes app.integrations.firehydrant, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.firehydrant.default.* or app.integrations.firehydrant.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need FireHydrant, use the narrower mcp:lua command.

MCP Lua command
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

FireHydrant Lua API

Generated from FireHydrant’s official ReadMe API registry OpenAPI document (dnq41ujmori9g73). The namespace is app.integrations.firehydrant.

This package exposes 477 endpoint-specific tools: 218 read tools and 259 write tools. Use a FireHydrant API token with permissions for the endpoints you call.

Usage

local ping = app.integrations.firehydrant.ping({})

local incidents = app.integrations.firehydrant.list_incidents({
  page = 1,
  per_page = 25
})

Request Bodies

Tools that create, update, patch, or delete resources may accept a body table. The table is passed as the JSON body expected by the FireHydrant OpenAPI schema. Path and query arguments use snake_case names and are mapped back to the official parameter names.

Example Tools

| firehydrant_ping | read | GET /v1/ping | | firehydrant_list_environments | read | GET /v1/environments | | firehydrant_create_environment | write | POST /v1/environments | | firehydrant_get_environment | read | GET /v1/environments/{environment_id} | | firehydrant_update_environment | write | PATCH /v1/environments/{environment_id} | | firehydrant_delete_environment | write | DELETE /v1/environments/{environment_id} | | firehydrant_list_environment_services | read | GET /v1/environments/{environment_id}/services | | firehydrant_list_environment_functionalities | read | GET /v1/environments/{environment_id}/functionalities | | firehydrant_list_services | read | GET /v1/services | | firehydrant_create_service | write | POST /v1/services | | firehydrant_create_service_links | write | POST /v1/services/service_links | | firehydrant_get_service | read | GET /v1/services/{service_id} | | firehydrant_update_service | write | PATCH /v1/services/{service_id} | | firehydrant_delete_service | write | DELETE /v1/services/{service_id} | | firehydrant_list_service_environments | read | GET /v1/services/{service_id}/environments | | firehydrant_get_service_dependencies | read | GET /v1/services/{service_id}/dependencies | | firehydrant_list_service_available_upstream_dependencies | read | GET /v1/services/{service_id}/available_upstream_dependencies | | firehydrant_list_service_available_downstream_dependencies | read | GET /v1/services/{service_id}/available_downstream_dependencies | | firehydrant_delete_service_link | write | DELETE /v1/services/{service_id}/service_links/{remote_id} | | firehydrant_create_service_checklist_response | write | POST /v1/services/{service_id}/checklist_response/{checklist_id} | | firehydrant_create_service_dependency | write | POST /v1/service_dependencies | | firehydrant_get_service_dependency | read | GET /v1/service_dependencies/{service_dependency_id} | | firehydrant_update_service_dependency | write | PATCH /v1/service_dependencies/{service_dependency_id} | | firehydrant_delete_service_dependency | write | DELETE /v1/service_dependencies/{service_dependency_id} | | firehydrant_list_functionalities | read | GET /v1/functionalities | | firehydrant_create_functionality | write | POST /v1/functionalities | | firehydrant_get_functionality | read | GET /v1/functionalities/{functionality_id} | | firehydrant_update_functionality | write | PATCH /v1/functionalities/{functionality_id} | | firehydrant_delete_functionality | write | DELETE /v1/functionalities/{functionality_id} | | firehydrant_list_functionality_environments | read | GET /v1/functionalities/{functionality_id}/environments | | firehydrant_list_functionality_services | read | GET /v1/functionalities/{functionality_id}/services | | firehydrant_list_teams | read | GET /v1/teams |

Notes

  • The base URL defaults to https://api.firehydrant.io.
  • EU organizations can set url to https://api.eu.firehydrant.io.
  • Authentication uses Authorization: Bearer <api_token>.
  • Returned data is the parsed JSON response from FireHydrant.
Raw agent markdown
# FireHydrant Lua API

Generated from FireHydrant's official ReadMe API registry OpenAPI document (`dnq41ujmori9g73`). The namespace is `app.integrations.firehydrant`.

This package exposes 477 endpoint-specific tools: 218 read tools and 259 write tools. Use a FireHydrant API token with permissions for the endpoints you call.

## Usage

```lua
local ping = app.integrations.firehydrant.ping({})

local incidents = app.integrations.firehydrant.list_incidents({
  page = 1,
  per_page = 25
})
```

## Request Bodies

Tools that create, update, patch, or delete resources may accept a `body` table. The table is passed as the JSON body expected by the FireHydrant OpenAPI schema. Path and query arguments use snake_case names and are mapped back to the official parameter names.

## Example Tools

| `firehydrant_ping` | read | GET `/v1/ping` |
| `firehydrant_list_environments` | read | GET `/v1/environments` |
| `firehydrant_create_environment` | write | POST `/v1/environments` |
| `firehydrant_get_environment` | read | GET `/v1/environments/{environment_id}` |
| `firehydrant_update_environment` | write | PATCH `/v1/environments/{environment_id}` |
| `firehydrant_delete_environment` | write | DELETE `/v1/environments/{environment_id}` |
| `firehydrant_list_environment_services` | read | GET `/v1/environments/{environment_id}/services` |
| `firehydrant_list_environment_functionalities` | read | GET `/v1/environments/{environment_id}/functionalities` |
| `firehydrant_list_services` | read | GET `/v1/services` |
| `firehydrant_create_service` | write | POST `/v1/services` |
| `firehydrant_create_service_links` | write | POST `/v1/services/service_links` |
| `firehydrant_get_service` | read | GET `/v1/services/{service_id}` |
| `firehydrant_update_service` | write | PATCH `/v1/services/{service_id}` |
| `firehydrant_delete_service` | write | DELETE `/v1/services/{service_id}` |
| `firehydrant_list_service_environments` | read | GET `/v1/services/{service_id}/environments` |
| `firehydrant_get_service_dependencies` | read | GET `/v1/services/{service_id}/dependencies` |
| `firehydrant_list_service_available_upstream_dependencies` | read | GET `/v1/services/{service_id}/available_upstream_dependencies` |
| `firehydrant_list_service_available_downstream_dependencies` | read | GET `/v1/services/{service_id}/available_downstream_dependencies` |
| `firehydrant_delete_service_link` | write | DELETE `/v1/services/{service_id}/service_links/{remote_id}` |
| `firehydrant_create_service_checklist_response` | write | POST `/v1/services/{service_id}/checklist_response/{checklist_id}` |
| `firehydrant_create_service_dependency` | write | POST `/v1/service_dependencies` |
| `firehydrant_get_service_dependency` | read | GET `/v1/service_dependencies/{service_dependency_id}` |
| `firehydrant_update_service_dependency` | write | PATCH `/v1/service_dependencies/{service_dependency_id}` |
| `firehydrant_delete_service_dependency` | write | DELETE `/v1/service_dependencies/{service_dependency_id}` |
| `firehydrant_list_functionalities` | read | GET `/v1/functionalities` |
| `firehydrant_create_functionality` | write | POST `/v1/functionalities` |
| `firehydrant_get_functionality` | read | GET `/v1/functionalities/{functionality_id}` |
| `firehydrant_update_functionality` | write | PATCH `/v1/functionalities/{functionality_id}` |
| `firehydrant_delete_functionality` | write | DELETE `/v1/functionalities/{functionality_id}` |
| `firehydrant_list_functionality_environments` | read | GET `/v1/functionalities/{functionality_id}/environments` |
| `firehydrant_list_functionality_services` | read | GET `/v1/functionalities/{functionality_id}/services` |
| `firehydrant_list_teams` | read | GET `/v1/teams` |


## Notes

- The base URL defaults to `https://api.firehydrant.io`.
- EU organizations can set `url` to `https://api.eu.firehydrant.io`.
- Authentication uses `Authorization: Bearer <api_token>`.
- Returned data is the parsed JSON response from FireHydrant.
Metadata-derived Lua example
local result = app.integrations.firehydrant.check_api_connectivity({})
print(result)

Functions

check_api_connectivity Read

Check API connectivity Official FireHydrant endpoint: GET /v1/ping Simple endpoint to verify your API connection is working

Lua path
app.integrations.firehydrant.check_api_connectivity
Full name
firehydrant.firehydrant_ping
ParameterTypeRequiredDescription
No parameters.
list_environments Read

List environments Official FireHydrant endpoint: GET /v1/environments List all of the environments that have been added to the organiation

Lua path
app.integrations.firehydrant.list_environments
Full name
firehydrant.firehydrant_list_environments
ParameterTypeRequiredDescription
No parameters.
create_environment Write

Create an environment Official FireHydrant endpoint: POST /v1/environments Creates an environment for the organization

Lua path
app.integrations.firehydrant.create_environment
Full name
firehydrant.firehydrant_create_environment
ParameterTypeRequiredDescription
No parameters.
get_environment Read

Get an environment Official FireHydrant endpoint: GET /v1/environments/{environment_id} Retrieves a single environment by ID

Lua path
app.integrations.firehydrant.get_environment
Full name
firehydrant.firehydrant_get_environment
ParameterTypeRequiredDescription
No parameters.
update_environment Write

Update an environment Official FireHydrant endpoint: PATCH /v1/environments/{environment_id} Update a environments attributes

Lua path
app.integrations.firehydrant.update_environment
Full name
firehydrant.firehydrant_update_environment
ParameterTypeRequiredDescription
No parameters.
archive_environment Write

Archive an environment Official FireHydrant endpoint: DELETE /v1/environments/{environment_id} Archive an environment

Lua path
app.integrations.firehydrant.archive_environment
Full name
firehydrant.firehydrant_delete_environment
ParameterTypeRequiredDescription
No parameters.
list_services_environment Read

List services for an environment Official FireHydrant endpoint: GET /v1/environments/{environment_id}/services List services for an environment

Lua path
app.integrations.firehydrant.list_services_environment
Full name
firehydrant.firehydrant_list_environment_services
ParameterTypeRequiredDescription
No parameters.
list_functionalities_environment Read

List functionalities for an environment Official FireHydrant endpoint: GET /v1/environments/{environment_id}/functionalities List functionalities for an environment

Lua path
app.integrations.firehydrant.list_functionalities_environment
Full name
firehydrant.firehydrant_list_environment_functionalities
ParameterTypeRequiredDescription
No parameters.
list_services Read

List services Official FireHydrant endpoint: GET /v1/services List all of the services that have been added to the organization.

Lua path
app.integrations.firehydrant.list_services
Full name
firehydrant.firehydrant_list_services
ParameterTypeRequiredDescription
No parameters.
create_service Write

Create a service Official FireHydrant endpoint: POST /v1/services Creates a service for the organization, you may also create or attach functionalities to the service on create.

Lua path
app.integrations.firehydrant.create_service
Full name
firehydrant.firehydrant_create_service
ParameterTypeRequiredDescription
No parameters.
create_multiple_services_linked_external_services Write

Create multiple services linked to external services Official FireHydrant endpoint: POST /v1/services/service_links Creates a service with the appropriate integration for each external service ID passed

Lua path
app.integrations.firehydrant.create_multiple_services_linked_external_services
Full name
firehydrant.firehydrant_create_service_links
ParameterTypeRequiredDescription
No parameters.
get_service Read

Get a service Official FireHydrant endpoint: GET /v1/services/{service_id} Retrieves a single service by ID

Lua path
app.integrations.firehydrant.get_service
Full name
firehydrant.firehydrant_get_service
ParameterTypeRequiredDescription
No parameters.
update_service Write

Update a service Official FireHydrant endpoint: PATCH /v1/services/{service_id} Update a services attributes, you may also add or remove functionalities from the service as well. Note: You may not remove or add individual label key/value pa

Lua path
app.integrations.firehydrant.update_service
Full name
firehydrant.firehydrant_update_service
ParameterTypeRequiredDescription
No parameters.
delete_service Write

Delete a service Official FireHydrant endpoint: DELETE /v1/services/{service_id} Deletes the service from FireHydrant.

Lua path
app.integrations.firehydrant.delete_service
Full name
firehydrant.firehydrant_delete_service
ParameterTypeRequiredDescription
No parameters.
list_environments_service Read

List environments for a service Official FireHydrant endpoint: GET /v1/services/{service_id}/environments List environments for a service

Lua path
app.integrations.firehydrant.list_environments_service
Full name
firehydrant.firehydrant_list_service_environments
ParameterTypeRequiredDescription
No parameters.
list_dependencies_service Read

List dependencies for a service Official FireHydrant endpoint: GET /v1/services/{service_id}/dependencies Retrieves a service's dependencies

Lua path
app.integrations.firehydrant.list_dependencies_service
Full name
firehydrant.firehydrant_get_service_dependencies
ParameterTypeRequiredDescription
No parameters.
list_available_upstream_service_dependencies Read

List available upstream service dependencies Official FireHydrant endpoint: GET /v1/services/{service_id}/available_upstream_dependencies Retrieves all services that are available to be upstream dependencies

Lua path
app.integrations.firehydrant.list_available_upstream_service_dependencies
Full name
firehydrant.firehydrant_list_service_available_upstream_dependencies
ParameterTypeRequiredDescription
No parameters.
list_available_downstream_service_dependencies Read

List available downstream service dependencies Official FireHydrant endpoint: GET /v1/services/{service_id}/available_downstream_dependencies Retrieves all services that are available to be downstream dependencies

Lua path
app.integrations.firehydrant.list_available_downstream_service_dependencies
Full name
firehydrant.firehydrant_list_service_available_downstream_dependencies
ParameterTypeRequiredDescription
No parameters.
record_response_checklist_item Write

Record a response for a checklist item Official FireHydrant endpoint: POST /v1/services/{service_id}/checklist_response/{checklist_id} Creates a response for a checklist item

Lua path
app.integrations.firehydrant.record_response_checklist_item
Full name
firehydrant.firehydrant_create_service_checklist_response
ParameterTypeRequiredDescription
No parameters.
create_service_dependency Write

Create a service dependency Official FireHydrant endpoint: POST /v1/service_dependencies Creates a service dependency relationship between two services

Lua path
app.integrations.firehydrant.create_service_dependency
Full name
firehydrant.firehydrant_create_service_dependency
ParameterTypeRequiredDescription
No parameters.
get_service_dependency Read

Get a service dependency Official FireHydrant endpoint: GET /v1/service_dependencies/{service_dependency_id} Retrieves a single service dependency by ID

Lua path
app.integrations.firehydrant.get_service_dependency
Full name
firehydrant.firehydrant_get_service_dependency
ParameterTypeRequiredDescription
No parameters.
update_service_dependency Write

Update a service dependency Official FireHydrant endpoint: PATCH /v1/service_dependencies/{service_dependency_id} Update the notes of the service dependency

Lua path
app.integrations.firehydrant.update_service_dependency
Full name
firehydrant.firehydrant_update_service_dependency
ParameterTypeRequiredDescription
No parameters.
delete_service_dependency Write

Delete a service dependency Official FireHydrant endpoint: DELETE /v1/service_dependencies/{service_dependency_id} Deletes a single service dependency

Lua path
app.integrations.firehydrant.delete_service_dependency
Full name
firehydrant.firehydrant_delete_service_dependency
ParameterTypeRequiredDescription
No parameters.
list_functionalities Read

List functionalities Official FireHydrant endpoint: GET /v1/functionalities List all of the functionalities that have been added to the organiation

Lua path
app.integrations.firehydrant.list_functionalities
Full name
firehydrant.firehydrant_list_functionalities
ParameterTypeRequiredDescription
No parameters.
create_functionality Write

Create a functionality Official FireHydrant endpoint: POST /v1/functionalities Creates a functionality for the organization

Lua path
app.integrations.firehydrant.create_functionality
Full name
firehydrant.firehydrant_create_functionality
ParameterTypeRequiredDescription
No parameters.
get_functionality Read

Get a functionality Official FireHydrant endpoint: GET /v1/functionalities/{functionality_id} Retrieves a single functionality by ID

Lua path
app.integrations.firehydrant.get_functionality
Full name
firehydrant.firehydrant_get_functionality
ParameterTypeRequiredDescription
No parameters.
update_functionality Write

Update a functionality Official FireHydrant endpoint: PATCH /v1/functionalities/{functionality_id} Update a functionalities attributes

Lua path
app.integrations.firehydrant.update_functionality
Full name
firehydrant.firehydrant_update_functionality
ParameterTypeRequiredDescription
No parameters.
archive_functionality Write

Archive a functionality Official FireHydrant endpoint: DELETE /v1/functionalities/{functionality_id} Archive a functionality

Lua path
app.integrations.firehydrant.archive_functionality
Full name
firehydrant.firehydrant_delete_functionality
ParameterTypeRequiredDescription
No parameters.
list_environments_functionality Read

List environments for a functionality Official FireHydrant endpoint: GET /v1/functionalities/{functionality_id}/environments List environments for a functionality

Lua path
app.integrations.firehydrant.list_environments_functionality
Full name
firehydrant.firehydrant_list_functionality_environments
ParameterTypeRequiredDescription
No parameters.
list_services_functionality Read

List services for a functionality Official FireHydrant endpoint: GET /v1/functionalities/{functionality_id}/services List services for a functionality

Lua path
app.integrations.firehydrant.list_services_functionality
Full name
firehydrant.firehydrant_list_functionality_services
ParameterTypeRequiredDescription
No parameters.
list_teams Read

List teams Official FireHydrant endpoint: GET /v1/teams List all of the teams in the organization

Lua path
app.integrations.firehydrant.list_teams
Full name
firehydrant.firehydrant_list_teams
ParameterTypeRequiredDescription
No parameters.
create_team Write

Create a team Official FireHydrant endpoint: POST /v1/teams Create a new team

Lua path
app.integrations.firehydrant.create_team
Full name
firehydrant.firehydrant_create_team
ParameterTypeRequiredDescription
No parameters.
get_team Read

Get a team Official FireHydrant endpoint: GET /v1/teams/{team_id} Retrieve a single team from its ID

Lua path
app.integrations.firehydrant.get_team
Full name
firehydrant.firehydrant_get_team
ParameterTypeRequiredDescription
No parameters.
update_team Write

Update a team Official FireHydrant endpoint: PATCH /v1/teams/{team_id} Update a single team from its ID

Lua path
app.integrations.firehydrant.update_team
Full name
firehydrant.firehydrant_update_team
ParameterTypeRequiredDescription
No parameters.
archive_team Write

Archive a team Official FireHydrant endpoint: DELETE /v1/teams/{team_id} Archives an team which will hide it from lists and metrics

Lua path
app.integrations.firehydrant.archive_team
Full name
firehydrant.firehydrant_delete_team
ParameterTypeRequiredDescription
No parameters.
get_support_hours_schedule Read

Get support hours schedule Official FireHydrant endpoint: GET /v1/teams/{team_id}/support_hours_schedule Get support hours schedule for the team

Lua path
app.integrations.firehydrant.get_support_hours_schedule
Full name
firehydrant.firehydrant_get_support_hours_schedule
ParameterTypeRequiredDescription
No parameters.
update_support_hours_schedule Write

Update support hours schedule Official FireHydrant endpoint: PATCH /v1/teams/{team_id}/support_hours_schedule Update the team's support hours schedule

Lua path
app.integrations.firehydrant.update_support_hours_schedule
Full name
firehydrant.firehydrant_update_support_hours_schedule
ParameterTypeRequiredDescription
No parameters.
delete_specific_support_hours_schedule Write

Delete a specific support hours schedule Official FireHydrant endpoint: DELETE /v1/teams/{team_id}/support_hours_schedule Delete a specific support hours schedule

Lua path
app.integrations.firehydrant.delete_specific_support_hours_schedule
Full name
firehydrant.firehydrant_delete_support_hours_schedule
ParameterTypeRequiredDescription
No parameters.
list_call_routes_team Read

List call routes for a team Official FireHydrant endpoint: GET /v1/teams/{team_id}/call_routes List call routes for a team

Lua path
app.integrations.firehydrant.list_call_routes_team
Full name
firehydrant.firehydrant_list_team_call_routes
ParameterTypeRequiredDescription
No parameters.
create_call_route_team Write

Create a call route for a team Official FireHydrant endpoint: POST /v1/teams/{team_id}/call_routes Create a call route for a team

Lua path
app.integrations.firehydrant.create_call_route_team
Full name
firehydrant.firehydrant_create_team_call_route
ParameterTypeRequiredDescription
No parameters.
list_escalation_policies_team Read

List escalation policies for a team Official FireHydrant endpoint: GET /v1/teams/{team_id}/escalation_policies List all Signals escalation policies for a team.

Lua path
app.integrations.firehydrant.list_escalation_policies_team
Full name
firehydrant.firehydrant_list_team_escalation_policies
ParameterTypeRequiredDescription
No parameters.
create_escalation_policy_team Write

Create an escalation policy for a team Official FireHydrant endpoint: POST /v1/teams/{team_id}/escalation_policies Create a Signals escalation policy for a team.

Lua path
app.integrations.firehydrant.create_escalation_policy_team
Full name
firehydrant.firehydrant_create_team_escalation_policy
ParameterTypeRequiredDescription
No parameters.
get_escalation_policy_team Read

Get an escalation policy for a team Official FireHydrant endpoint: GET /v1/teams/{team_id}/escalation_policies/{id} Get a Signals escalation policy by ID

Lua path
app.integrations.firehydrant.get_escalation_policy_team
Full name
firehydrant.firehydrant_get_team_escalation_policy
ParameterTypeRequiredDescription
No parameters.
update_escalation_policy_team Write

Update an escalation policy for a team Official FireHydrant endpoint: PATCH /v1/teams/{team_id}/escalation_policies/{id} Update a Signals escalation policy by ID

Lua path
app.integrations.firehydrant.update_escalation_policy_team
Full name
firehydrant.firehydrant_update_team_escalation_policy
ParameterTypeRequiredDescription
No parameters.
delete_escalation_policy_team Write

Delete an escalation policy for a team Official FireHydrant endpoint: DELETE /v1/teams/{team_id}/escalation_policies/{id} Delete a Signals escalation policy by ID

Lua path
app.integrations.firehydrant.delete_escalation_policy_team
Full name
firehydrant.firehydrant_delete_team_escalation_policy
ParameterTypeRequiredDescription
No parameters.
preview_new_call_schedule_team Write

Preview a new on-call schedule for a team Official FireHydrant endpoint: POST /v1/teams/{team_id}/on_call_schedules/preview Preview a new on-call schedule based on the provided rotations, allowing you to see how the schedule will look befor

Lua path
app.integrations.firehydrant.preview_new_call_schedule_team
Full name
firehydrant.firehydrant_preview_team_on_call_schedule
ParameterTypeRequiredDescription
No parameters.
list_call_schedules_team Read

List on-call schedules for a team Official FireHydrant endpoint: GET /v1/teams/{team_id}/on_call_schedules List all Signals on-call schedules for a team.

Lua path
app.integrations.firehydrant.list_call_schedules_team
Full name
firehydrant.firehydrant_list_team_on_call_schedules
ParameterTypeRequiredDescription
No parameters.
create_call_schedule_team Write

Create an on-call schedule for a team Official FireHydrant endpoint: POST /v1/teams/{team_id}/on_call_schedules Create a Signals on-call schedule for a team with a single rotation. More rotations can be created later.

Lua path
app.integrations.firehydrant.create_call_schedule_team
Full name
firehydrant.firehydrant_create_team_on_call_schedule
ParameterTypeRequiredDescription
No parameters.
get_call_schedule_team Read

Get an on-call schedule for a team Official FireHydrant endpoint: GET /v1/teams/{team_id}/on_call_schedules/{schedule_id} Get a Signals on-call schedule by ID

Lua path
app.integrations.firehydrant.get_call_schedule_team
Full name
firehydrant.firehydrant_get_team_on_call_schedule
ParameterTypeRequiredDescription
No parameters.
update_call_schedule_team Write

Update an on-call schedule for a team Official FireHydrant endpoint: PATCH /v1/teams/{team_id}/on_call_schedules/{schedule_id} Update a Signals on-call schedule by ID. For backwards compatibility, all parameters except for `name` and `descr

Lua path
app.integrations.firehydrant.update_call_schedule_team
Full name
firehydrant.firehydrant_update_team_on_call_schedule
ParameterTypeRequiredDescription
No parameters.
delete_call_schedule_team Write

Delete an on-call schedule for a team Official FireHydrant endpoint: DELETE /v1/teams/{team_id}/on_call_schedules/{schedule_id} Delete a Signals on-call schedule by ID

Lua path
app.integrations.firehydrant.delete_call_schedule_team
Full name
firehydrant.firehydrant_delete_team_on_call_schedule
ParameterTypeRequiredDescription
No parameters.
preview_call_rotation Write

Preview an on-call rotation Official FireHydrant endpoint: POST /v1/teams/{team_id}/on_call_schedules/{schedule_id}/rotations/preview Preview a new on-call rotation orchanges to an existing on-call rotation

Lua path
app.integrations.firehydrant.preview_call_rotation
Full name
firehydrant.firehydrant_preview_on_call_schedule_rotation
ParameterTypeRequiredDescription
No parameters.
create_new_call_rotation Write

Create a new on-call rotation Official FireHydrant endpoint: POST /v1/teams/{team_id}/on_call_schedules/{schedule_id}/rotations Add a new rotation to an existing on-call schedule

Lua path
app.integrations.firehydrant.create_new_call_rotation
Full name
firehydrant.firehydrant_create_on_call_schedule_rotation
ParameterTypeRequiredDescription
No parameters.
copy_call_schedule_rotation Write

Copy an on-call schedule's rotation Official FireHydrant endpoint: POST /v1/teams/{team_id}/on_call_schedules/{schedule_id}/rotations/{rotation_id}/copy Copy an on-call rotation into a different schedule, allowing you to merge them together

Lua path
app.integrations.firehydrant.copy_call_schedule_rotation
Full name
firehydrant.firehydrant_copy_on_call_schedule_rotation
ParameterTypeRequiredDescription
No parameters.
get_call_rotation Read

Get an on-call rotation Official FireHydrant endpoint: GET /v1/teams/{team_id}/on_call_schedules/{schedule_id}/rotations/{rotation_id} Get an on-call rotation by ID

Lua path
app.integrations.firehydrant.get_call_rotation
Full name
firehydrant.firehydrant_get_on_call_schedule_rotation
ParameterTypeRequiredDescription
No parameters.
update_call_schedule_rotation Write

Update an on-call schedule's rotation Official FireHydrant endpoint: PATCH /v1/teams/{team_id}/on_call_schedules/{schedule_id}/rotations/{rotation_id} Update an on-call schedule's rotation by ID

Lua path
app.integrations.firehydrant.update_call_schedule_rotation
Full name
firehydrant.firehydrant_update_on_call_schedule_rotation
ParameterTypeRequiredDescription
No parameters.
delete_call_schedule_rotation Write

Delete an on-call schedule's rotation Official FireHydrant endpoint: DELETE /v1/teams/{team_id}/on_call_schedules/{schedule_id}/rotations/{rotation_id} Delete an on-call schedule's rotation by ID

Lua path
app.integrations.firehydrant.delete_call_schedule_rotation
Full name
firehydrant.firehydrant_delete_on_call_schedule_rotation
ParameterTypeRequiredDescription
No parameters.
override_one_or_more_shifts_call_rotation Write

Override one or more shifts in an on-call rotation Official FireHydrant endpoint: POST /v1/teams/{team_id}/on_call_schedules/{schedule_id}/rotations/{rotation_id}/overrides Create an override covering a specific time period in an on-call ro

Lua path
app.integrations.firehydrant.override_one_or_more_shifts_call_rotation
Full name
firehydrant.firehydrant_override_on_call_schedule_rotation_shifts
ParameterTypeRequiredDescription
No parameters.
create_shift_call_schedule Write

Create a shift for an on-call schedule Official FireHydrant endpoint: POST /v1/teams/{team_id}/on_call_schedules/{schedule_id}/shifts Create a Signals on-call shift in a schedule.

Lua path
app.integrations.firehydrant.create_shift_call_schedule
Full name
firehydrant.firehydrant_create_on_call_shift
ParameterTypeRequiredDescription
No parameters.
get_call_shift_team_schedule Read

Get an on-call shift for a team schedule Official FireHydrant endpoint: GET /v1/teams/{team_id}/on_call_schedules/{schedule_id}/shifts/{id} Get a Signals on-call shift by ID

Lua path
app.integrations.firehydrant.get_call_shift_team_schedule
Full name
firehydrant.firehydrant_get_on_call_shift
ParameterTypeRequiredDescription
No parameters.
update_call_shift_team_schedule Write

Update an on-call shift for a team schedule Official FireHydrant endpoint: PATCH /v1/teams/{team_id}/on_call_schedules/{schedule_id}/shifts/{id} Update a Signals on-call shift by ID

Lua path
app.integrations.firehydrant.update_call_shift_team_schedule
Full name
firehydrant.firehydrant_update_on_call_shift
ParameterTypeRequiredDescription
No parameters.
delete_call_shift_from_team_schedule Write

Delete an on-call shift from a team schedule Official FireHydrant endpoint: DELETE /v1/teams/{team_id}/on_call_schedules/{schedule_id}/shifts/{id} Delete a Signals on-call shift by ID

Lua path
app.integrations.firehydrant.delete_call_shift_from_team_schedule
Full name
firehydrant.firehydrant_delete_on_call_shift
ParameterTypeRequiredDescription
No parameters.
list_signals_rules Read

List Signals rules Official FireHydrant endpoint: GET /v1/teams/{team_id}/signal_rules List all Signals rules for a team.

Lua path
app.integrations.firehydrant.list_signals_rules
Full name
firehydrant.firehydrant_list_team_signal_rules
ParameterTypeRequiredDescription
No parameters.
create_signals_rule Write

Create a Signals rule Official FireHydrant endpoint: POST /v1/teams/{team_id}/signal_rules Create a Signals rule for a team. We support up to 2000 rules per organization.

Lua path
app.integrations.firehydrant.create_signals_rule
Full name
firehydrant.firehydrant_create_team_signal_rule
ParameterTypeRequiredDescription
No parameters.
get_signals_rule Read

Get a Signals rule Official FireHydrant endpoint: GET /v1/teams/{team_id}/signal_rules/{id} Get a Signals rule by ID.

Lua path
app.integrations.firehydrant.get_signals_rule
Full name
firehydrant.firehydrant_get_team_signal_rule
ParameterTypeRequiredDescription
No parameters.
update_signals_rule Write

Update a Signals rule Official FireHydrant endpoint: PATCH /v1/teams/{team_id}/signal_rules/{id} Update a Signals rule by ID

Lua path
app.integrations.firehydrant.update_signals_rule
Full name
firehydrant.firehydrant_update_team_signal_rule
ParameterTypeRequiredDescription
No parameters.
delete_signals_rule Write

Delete a Signals rule Official FireHydrant endpoint: DELETE /v1/teams/{team_id}/signal_rules/{id} Delete a Signals rule by ID

Lua path
app.integrations.firehydrant.delete_signals_rule
Full name
firehydrant.firehydrant_delete_team_signal_rule
ParameterTypeRequiredDescription
No parameters.
list_changes Read

List changes Official FireHydrant endpoint: GET /v1/changes List changes for the organization

Lua path
app.integrations.firehydrant.list_changes
Full name
firehydrant.firehydrant_list_changes
ParameterTypeRequiredDescription
No parameters.
create_new_change_entry Write

Create a new change entry Official FireHydrant endpoint: POST /v1/changes Create a new change entry

Lua path
app.integrations.firehydrant.create_new_change_entry
Full name
firehydrant.firehydrant_create_change
ParameterTypeRequiredDescription
No parameters.
update_change_entry Write

Update a change entry Official FireHydrant endpoint: PATCH /v1/changes/{change_id} Update a change entry

Lua path
app.integrations.firehydrant.update_change_entry
Full name
firehydrant.firehydrant_update_change
ParameterTypeRequiredDescription
No parameters.
archive_change_entry Write

Archive a change entry Official FireHydrant endpoint: DELETE /v1/changes/{change_id} Archive a change entry

Lua path
app.integrations.firehydrant.archive_change_entry
Full name
firehydrant.firehydrant_delete_change
ParameterTypeRequiredDescription
No parameters.
list_identities_change_entry Read

List identities for a change entry Official FireHydrant endpoint: GET /v1/changes/{change_id}/identities Retrieve all identities for the change entry

Lua path
app.integrations.firehydrant.list_identities_change_entry
Full name
firehydrant.firehydrant_list_change_identities
ParameterTypeRequiredDescription
No parameters.
create_identity_change_entry Write

Create an identity for a change entry Official FireHydrant endpoint: POST /v1/changes/{change_id}/identities Create an identity for the change entry

Lua path
app.integrations.firehydrant.create_identity_change_entry
Full name
firehydrant.firehydrant_create_change_identity
ParameterTypeRequiredDescription
No parameters.
update_identity_change_entry Write

Update an identity for a change entry Official FireHydrant endpoint: PATCH /v1/changes/{change_id}/identities/{identity_id} Update an identity for the change entry

Lua path
app.integrations.firehydrant.update_identity_change_entry
Full name
firehydrant.firehydrant_update_change_identity
ParameterTypeRequiredDescription
No parameters.
delete_identity_from_change_entry Write

Delete an identity from a change entry Official FireHydrant endpoint: DELETE /v1/changes/{change_id}/identities/{identity_id} Delete an identity from the change entry

Lua path
app.integrations.firehydrant.delete_identity_from_change_entry
Full name
firehydrant.firehydrant_delete_change_identity
ParameterTypeRequiredDescription
No parameters.
list_change_events Read

List change events Official FireHydrant endpoint: GET /v1/changes/events List change events for the organization. Note: Not all information is included on a change event like attachments and related changes. You must fetch a change event se

Lua path
app.integrations.firehydrant.list_change_events
Full name
firehydrant.firehydrant_list_change_events
ParameterTypeRequiredDescription
No parameters.
create_change_event Write

Create a change event Official FireHydrant endpoint: POST /v1/changes/events Create a change event

Lua path
app.integrations.firehydrant.create_change_event
Full name
firehydrant.firehydrant_create_change_event
ParameterTypeRequiredDescription
No parameters.
get_change_event Read

Get a change event Official FireHydrant endpoint: GET /v1/changes/events/{change_event_id} Retrieve a change event

Lua path
app.integrations.firehydrant.get_change_event
Full name
firehydrant.firehydrant_get_change_event
ParameterTypeRequiredDescription
No parameters.
update_change_event Write

Update a change event Official FireHydrant endpoint: PATCH /v1/changes/events/{change_event_id} Update a change event

Lua path
app.integrations.firehydrant.update_change_event
Full name
firehydrant.firehydrant_update_change_event
ParameterTypeRequiredDescription
No parameters.
delete_change_event Write

Delete a change event Official FireHydrant endpoint: DELETE /v1/changes/events/{change_event_id} Delete a change event

Lua path
app.integrations.firehydrant.delete_change_event
Full name
firehydrant.firehydrant_delete_change_event
ParameterTypeRequiredDescription
No parameters.
list_change_types Read

List change types Official FireHydrant endpoint: GET /v1/change_types List change types for the organization

Lua path
app.integrations.firehydrant.list_change_types
Full name
firehydrant.firehydrant_list_change_types
ParameterTypeRequiredDescription
No parameters.
list_entitlements Read

List entitlements Official FireHydrant endpoint: GET /v1/entitlements List the organization's entitlements

Lua path
app.integrations.firehydrant.list_entitlements
Full name
firehydrant.firehydrant_list_entitlements
ParameterTypeRequiredDescription
No parameters.
list_incidents Read

List incidents Official FireHydrant endpoint: GET /v1/incidents List all of the incidents in the organization

Lua path
app.integrations.firehydrant.list_incidents
Full name
firehydrant.firehydrant_list_incidents
ParameterTypeRequiredDescription
No parameters.
create_incident Write

Create an incident Official FireHydrant endpoint: POST /v1/incidents Create a new incident

Lua path
app.integrations.firehydrant.create_incident
Full name
firehydrant.firehydrant_create_incident
ParameterTypeRequiredDescription
No parameters.
get_chat_channel_information_incident Read

Get chat channel information for an incident Official FireHydrant endpoint: GET /v1/incidents/{incident_id}/channel Gives chat channel information for the specified incident

Lua path
app.integrations.firehydrant.get_chat_channel_information_incident
Full name
firehydrant.firehydrant_get_incident_channel
ParameterTypeRequiredDescription
No parameters.
close_incident Write

Close an incident Official FireHydrant endpoint: PUT /v1/incidents/{incident_id}/close Closes an incident and optionally close all children

Lua path
app.integrations.firehydrant.close_incident
Full name
firehydrant.firehydrant_close_incident
ParameterTypeRequiredDescription
No parameters.
resolve_incident Write

Resolve an incident Official FireHydrant endpoint: PUT /v1/incidents/{incident_id}/resolve Resolves a currently active incident

Lua path
app.integrations.firehydrant.resolve_incident
Full name
firehydrant.firehydrant_resolve_incident
ParameterTypeRequiredDescription
No parameters.
get_incident Read

Get an incident Official FireHydrant endpoint: GET /v1/incidents/{incident_id} Retrieve a single incident from its ID

Lua path
app.integrations.firehydrant.get_incident
Full name
firehydrant.firehydrant_get_incident
ParameterTypeRequiredDescription
No parameters.
update_incident Write

Update an incident Official FireHydrant endpoint: PATCH /v1/incidents/{incident_id} Updates an incident with provided parameters

Lua path
app.integrations.firehydrant.update_incident
Full name
firehydrant.firehydrant_update_incident
ParameterTypeRequiredDescription
No parameters.
archive_incident Write

Archive an incident Official FireHydrant endpoint: DELETE /v1/incidents/{incident_id} Archives an incident which will hide it from lists and metrics

Lua path
app.integrations.firehydrant.archive_incident
Full name
firehydrant.firehydrant_delete_incident
ParameterTypeRequiredDescription
No parameters.
unarchive_incident Write

Unarchive an incident Official FireHydrant endpoint: POST /v1/incidents/{incident_id}/unarchive Unarchive an incident

Lua path
app.integrations.firehydrant.unarchive_incident
Full name
firehydrant.firehydrant_unarchive_incident
ParameterTypeRequiredDescription
No parameters.
list_alerts_incident Read

List alerts for an incident Official FireHydrant endpoint: GET /v1/incidents/{incident_id}/alerts List alerts that have been attached to an incident

Lua path
app.integrations.firehydrant.list_alerts_incident
Full name
firehydrant.firehydrant_list_incident_alerts
ParameterTypeRequiredDescription
No parameters.
attach_alert_incident Write

Attach an alert to an incident Official FireHydrant endpoint: POST /v1/incidents/{incident_id}/alerts Add an alert to an incident. FireHydrant needs to have ingested the alert from a third party system in order to attach it to the incident.

Lua path
app.integrations.firehydrant.attach_alert_incident
Full name
firehydrant.firehydrant_create_incident_alert
ParameterTypeRequiredDescription
No parameters.
set_alert_primary_incident Write

Set an alert as primary for an incident Official FireHydrant endpoint: PATCH /v1/incidents/{incident_id}/alerts/{incident_alert_id}/primary Setting an alert as primary will overwrite milestone times in the FireHydrant incident with times in

Lua path
app.integrations.firehydrant.set_alert_primary_incident
Full name
firehydrant.firehydrant_update_incident_alert_primary
ParameterTypeRequiredDescription
No parameters.
remove_alert_from_incident Write

Remove an alert from an incident Official FireHydrant endpoint: DELETE /v1/incidents/{incident_id}/alerts/{incident_alert_id} Remove an alert from an incident

Lua path
app.integrations.firehydrant.remove_alert_from_incident
Full name
firehydrant.firehydrant_delete_incident_alert
ParameterTypeRequiredDescription
No parameters.
update_milestone_times Write

Update milestone times Official FireHydrant endpoint: PUT /v1/incidents/{incident_id}/milestones/bulk_update Update milestone times in bulk for a given incident. All milestone times for an incident must occur in chronological order correspo

Lua path
app.integrations.firehydrant.update_milestone_times
Full name
firehydrant.firehydrant_bulk_update_incident_milestones
ParameterTypeRequiredDescription
No parameters.
list_incident_milestones Read

List incident milestones Official FireHydrant endpoint: GET /v1/incidents/{incident_id}/milestones List times and durations for each milestone on an incident

Lua path
app.integrations.firehydrant.list_incident_milestones
Full name
firehydrant.firehydrant_list_incident_milestones
ParameterTypeRequiredDescription
No parameters.
update_change_attached_incident Write

Update a change attached to an incident Official FireHydrant endpoint: PATCH /v1/incidents/{incident_id}/related_change_events/{related_change_event_id} Update a change attached to an incident

Lua path
app.integrations.firehydrant.update_change_attached_incident
Full name
firehydrant.firehydrant_update_incident_change_event
ParameterTypeRequiredDescription
No parameters.
list_status_pages_incident Read

List status pages for an incident Official FireHydrant endpoint: GET /v1/incidents/{incident_id}/status_pages List status pages that are attached to an incident

Lua path
app.integrations.firehydrant.list_status_pages_incident
Full name
firehydrant.firehydrant_list_incident_status_pages
ParameterTypeRequiredDescription
No parameters.
add_status_page_incident Write

Add a status page to an incident Official FireHydrant endpoint: POST /v1/incidents/{incident_id}/status_pages Add a status page to an incident.

Lua path
app.integrations.firehydrant.add_status_page_incident
Full name
firehydrant.firehydrant_create_incident_status_page
ParameterTypeRequiredDescription
No parameters.
remove_status_page_from_incident Write

Remove a status page from an incident Official FireHydrant endpoint: DELETE /v1/incidents/{incident_id}/status_pages/{status_page_id} Remove a status page incident attached to an incident

Lua path
app.integrations.firehydrant.remove_status_page_from_incident
Full name
firehydrant.firehydrant_delete_incident_status_page
ParameterTypeRequiredDescription
No parameters.
add_tasks_from_task_list_incident Write

Add tasks from a task list to an incident Official FireHydrant endpoint: POST /v1/incidents/{incident_id}/task_lists Add all tasks from list to incident

Lua path
app.integrations.firehydrant.add_tasks_from_task_list_incident
Full name
firehydrant.firehydrant_create_incident_task_list
ParameterTypeRequiredDescription
No parameters.
list_tasks_incident Read

List tasks for an incident Official FireHydrant endpoint: GET /v1/incidents/{incident_id}/tasks Retrieve a list of all tasks for a specific incident

Lua path
app.integrations.firehydrant.list_tasks_incident
Full name
firehydrant.firehydrant_list_incident_tasks
ParameterTypeRequiredDescription
No parameters.
create_incident_task Write

Create an incident task Official FireHydrant endpoint: POST /v1/incidents/{incident_id}/tasks Create a task

Lua path
app.integrations.firehydrant.create_incident_task
Full name
firehydrant.firehydrant_create_incident_task
ParameterTypeRequiredDescription
No parameters.
get_incident_task Read

Get an incident task Official FireHydrant endpoint: GET /v1/incidents/{incident_id}/tasks/{task_id} Retrieve a single task for an incident

Lua path
app.integrations.firehydrant.get_incident_task
Full name
firehydrant.firehydrant_get_incident_task
ParameterTypeRequiredDescription
No parameters.
update_incident_task Write

Update an incident task Official FireHydrant endpoint: PATCH /v1/incidents/{incident_id}/tasks/{task_id} Update a task's attributes

Lua path
app.integrations.firehydrant.update_incident_task
Full name
firehydrant.firehydrant_update_incident_task
ParameterTypeRequiredDescription
No parameters.
delete_incident_task Write

Delete an incident task Official FireHydrant endpoint: DELETE /v1/incidents/{incident_id}/tasks/{task_id} Delete a task

Lua path
app.integrations.firehydrant.delete_incident_task
Full name
firehydrant.firehydrant_delete_incident_task
ParameterTypeRequiredDescription
No parameters.
convert_task_follow_up Write

Convert a task to a follow-up Official FireHydrant endpoint: POST /v1/incidents/{incident_id}/tasks/{task_id}/convert Convert a task to a follow-up

Lua path
app.integrations.firehydrant.convert_task_follow_up
Full name
firehydrant.firehydrant_convert_incident_task
ParameterTypeRequiredDescription
No parameters.
update_attribution_transcript Write

Update the attribution of a transcript Official FireHydrant endpoint: PUT /v1/incidents/{incident_id}/transcript/attribution Update the attribution of a transcript

Lua path
app.integrations.firehydrant.update_attribution_transcript
Full name
firehydrant.firehydrant_update_transcript_attribution
ParameterTypeRequiredDescription
No parameters.
lists_all_messages_incident_transcript Read

Lists all of the messages in the incident's transcript Official FireHydrant endpoint: GET /v1/incidents/{incident_id}/transcript Retrieve the transcript for a specific incident

Lua path
app.integrations.firehydrant.lists_all_messages_incident_transcript
Full name
firehydrant.firehydrant_list_transcript_entries
ParameterTypeRequiredDescription
No parameters.
delete_transcript_from_incident Write

Delete a transcript from an incident Official FireHydrant endpoint: DELETE /v1/incidents/{incident_id}/transcript/{transcript_id} Delete a transcript from an incident

Lua path
app.integrations.firehydrant.delete_transcript_from_incident
Full name
firehydrant.firehydrant_delete_transcript_entry
ParameterTypeRequiredDescription
No parameters.
retrieve_all_conference_bridges_incident Read

Retrieve all conference bridges for an incident Official FireHydrant endpoint: GET /v1/incidents/{incident_id}/conference_bridges Retrieve all conference bridges for an incident

Lua path
app.integrations.firehydrant.retrieve_all_conference_bridges_incident
Full name
firehydrant.firehydrant_list_incident_conference_bridges
ParameterTypeRequiredDescription
No parameters.
retrieve_translations_specific_conference_bridge Read

Retrieve the translations for a specific conference bridge Official FireHydrant endpoint: GET /v1/incidents/{incident_id}/conference_bridges/{id}/translations/{language_code} Retrieve the translations for a specific conference bridge

Lua path
app.integrations.firehydrant.retrieve_translations_specific_conference_bridge
Full name
firehydrant.firehydrant_get_conference_bridge_translation
ParameterTypeRequiredDescription
No parameters.
list_similar_incidents Read

List similar incidents Official FireHydrant endpoint: GET /v1/incidents/{incident_id}/similar Retrieve a list of similar incidents

Lua path
app.integrations.firehydrant.list_similar_incidents
Full name
firehydrant.firehydrant_list_similar_incidents
ParameterTypeRequiredDescription
No parameters.
list_attachments_incident Read

List attachments for an incident Official FireHydrant endpoint: GET /v1/incidents/{incident_id}/attachments List attachments for an incident

Lua path
app.integrations.firehydrant.list_attachments_incident
Full name
firehydrant.firehydrant_list_incident_attachments
ParameterTypeRequiredDescription
No parameters.
add_attachment_incident_timeline Write

Add an attachment to the incident timeline Official FireHydrant endpoint: POST /v1/incidents/{incident_id}/attachments Allows adding image attachments to an incident

Lua path
app.integrations.firehydrant.add_attachment_incident_timeline
Full name
firehydrant.firehydrant_create_incident_attachment
ParameterTypeRequiredDescription
No parameters.
list_events_incident Read

List events for an incident Official FireHydrant endpoint: GET /v1/incidents/{incident_id}/events List all events for an incident. An event is a timeline entry. This can be filtered with params to retrieve events of a certain type.

Lua path
app.integrations.firehydrant.list_events_incident
Full name
firehydrant.firehydrant_list_incident_events
ParameterTypeRequiredDescription
No parameters.
get_incident_event Read

Get an incident event Official FireHydrant endpoint: GET /v1/incidents/{incident_id}/events/{event_id} Retrieve a single event for an incident

Lua path
app.integrations.firehydrant.get_incident_event
Full name
firehydrant.firehydrant_get_incident_event
ParameterTypeRequiredDescription
No parameters.
update_incident_event Write

Update an incident event Official FireHydrant endpoint: PATCH /v1/incidents/{incident_id}/events/{event_id} Update a single event for an incident

Lua path
app.integrations.firehydrant.update_incident_event
Full name
firehydrant.firehydrant_update_incident_event
ParameterTypeRequiredDescription
No parameters.
delete_incident_event Write

Delete an incident event Official FireHydrant endpoint: DELETE /v1/incidents/{incident_id}/events/{event_id} Delete an event for an incident

Lua path
app.integrations.firehydrant.delete_incident_event
Full name
firehydrant.firehydrant_delete_incident_event
ParameterTypeRequiredDescription
No parameters.
get_votes Read

Get votes Official FireHydrant endpoint: GET /v1/incidents/{incident_id}/events/{event_id}/votes/status Get an object's current vote counts

Lua path
app.integrations.firehydrant.get_votes
Full name
firehydrant.firehydrant_get_vote_status
ParameterTypeRequiredDescription
No parameters.
update_votes Write

Update votes Official FireHydrant endpoint: PATCH /v1/incidents/{incident_id}/events/{event_id}/votes Upvote or downvote an object

Lua path
app.integrations.firehydrant.update_votes
Full name
firehydrant.firehydrant_update_vote
ParameterTypeRequiredDescription
No parameters.
update_impacts_incident Write

Update impacts for an incident Official FireHydrant endpoint: PUT /v1/incidents/{incident_id}/impact Allows updating an incident's impacted infrastructure, with the option to move the incident into a different milestone and provide a note t

Lua path
app.integrations.firehydrant.update_impacts_incident
Full name
firehydrant.firehydrant_update_incident_impact_put
ParameterTypeRequiredDescription
No parameters.
update_impacts_incident Write

Update impacts for an incident Official FireHydrant endpoint: PATCH /v1/incidents/{incident_id}/impact Allows updating an incident's impacted infrastructure, with the option to move the incident into a different milestone and provide a note

Lua path
app.integrations.firehydrant.update_impacts_incident
Full name
firehydrant.firehydrant_update_incident_impact_patch
ParameterTypeRequiredDescription
No parameters.
list_impacted_infrastructure_incident Read

List impacted infrastructure for an incident Official FireHydrant endpoint: GET /v1/incidents/{incident_id}/impact/{type} List impacted infrastructure on an incident by specifying type

Lua path
app.integrations.firehydrant.list_impacted_infrastructure_incident
Full name
firehydrant.firehydrant_list_incident_impacts
ParameterTypeRequiredDescription
No parameters.
add_impacted_infrastructure_incident Write

Add impacted infrastructure to an incident Official FireHydrant endpoint: POST /v1/incidents/{incident_id}/impact/{type} Add impacted infrastructure to an incident

Lua path
app.integrations.firehydrant.add_impacted_infrastructure_incident
Full name
firehydrant.firehydrant_create_incident_impact
ParameterTypeRequiredDescription
No parameters.
remove_impacted_infrastructure_from_incident Write

Remove impacted infrastructure from an incident Official FireHydrant endpoint: DELETE /v1/incidents/{incident_id}/impact/{type}/{id} Remove impacted infrastructure from an incident

Lua path
app.integrations.firehydrant.remove_impacted_infrastructure_from_incident
Full name
firehydrant.firehydrant_delete_incident_impact
ParameterTypeRequiredDescription
No parameters.
add_note_incident Write

Add a note to an incident Official FireHydrant endpoint: POST /v1/incidents/{incident_id}/notes Create a new note on for an incident. The visibility field on a note determines where it gets posted.

Lua path
app.integrations.firehydrant.add_note_incident
Full name
firehydrant.firehydrant_create_incident_note
ParameterTypeRequiredDescription
No parameters.
update_note Write

Update a note Official FireHydrant endpoint: PATCH /v1/incidents/{incident_id}/notes/{note_id} Updates the body of a note

Lua path
app.integrations.firehydrant.update_note
Full name
firehydrant.firehydrant_update_incident_note
ParameterTypeRequiredDescription
No parameters.
add_chat_message_incident Write

Add a chat message to an incident Official FireHydrant endpoint: POST /v1/incidents/{incident_id}/generic_chat_messages Create a new generic chat message on an incident timeline. These are independent of any specific chat provider.

Lua path
app.integrations.firehydrant.add_chat_message_incident
Full name
firehydrant.firehydrant_create_incident_chat_message
ParameterTypeRequiredDescription
No parameters.
update_chat_message_incident Write

Update a chat message on an incident Official FireHydrant endpoint: PATCH /v1/incidents/{incident_id}/generic_chat_messages/{message_id} Update an existing generic chat message on an incident.

Lua path
app.integrations.firehydrant.update_chat_message_incident
Full name
firehydrant.firehydrant_update_incident_chat_message
ParameterTypeRequiredDescription
No parameters.
delete_chat_message_from_incident Write

Delete a chat message from an incident Official FireHydrant endpoint: DELETE /v1/incidents/{incident_id}/generic_chat_messages/{message_id} Delete an existing generic chat message on an incident.

Lua path
app.integrations.firehydrant.delete_chat_message_from_incident
Full name
firehydrant.firehydrant_delete_incident_chat_message
ParameterTypeRequiredDescription
No parameters.
list_incident_assignees Read

List incident assignees Official FireHydrant endpoint: GET /v1/incidents/{incident_id}/role_assignments Retrieve a list of all of the current role assignments for the incident

Lua path
app.integrations.firehydrant.list_incident_assignees
Full name
firehydrant.firehydrant_list_incident_role_assignments
ParameterTypeRequiredDescription
No parameters.
assign_user_incident Write

Assign a user to an incident Official FireHydrant endpoint: POST /v1/incidents/{incident_id}/role_assignments Assign a role to a user for this incident

Lua path
app.integrations.firehydrant.assign_user_incident
Full name
firehydrant.firehydrant_create_incident_role_assignment
ParameterTypeRequiredDescription
No parameters.
unassign_user_from_incident Write

Unassign a user from an incident Official FireHydrant endpoint: DELETE /v1/incidents/{incident_id}/role_assignments/{role_assignment_id} Unassign a role from a user

Lua path
app.integrations.firehydrant.unassign_user_from_incident
Full name
firehydrant.firehydrant_delete_incident_role_assignment
ParameterTypeRequiredDescription
No parameters.
assign_team_incident Write

Assign a team to an incident Official FireHydrant endpoint: POST /v1/incidents/{incident_id}/team_assignments Assign a team for this incident

Lua path
app.integrations.firehydrant.assign_team_incident
Full name
firehydrant.firehydrant_create_incident_team_assignment
ParameterTypeRequiredDescription
No parameters.
unassign_team_from_incident Write

Unassign a team from an incident Official FireHydrant endpoint: DELETE /v1/incidents/{incident_id}/team_assignments/{team_assignment_id} Unassign a team from an incident

Lua path
app.integrations.firehydrant.unassign_team_from_incident
Full name
firehydrant.firehydrant_delete_incident_team_assignment
ParameterTypeRequiredDescription
No parameters.
get_current_user_incident_role Read

Get the current user's incident role Official FireHydrant endpoint: GET /v1/incidents/{incident_id}/users/{user_id} Retrieve a user with current roles for an incident

Lua path
app.integrations.firehydrant.get_current_user_incident_role
Full name
firehydrant.firehydrant_get_incident_user
ParameterTypeRequiredDescription
No parameters.
list_incident_relationships Read

List incident relationships Official FireHydrant endpoint: GET /v1/incidents/{incident_id}/relationships List any parent/child relationships for an incident

Lua path
app.integrations.firehydrant.list_incident_relationships
Full name
firehydrant.firehydrant_get_incident_relationships
ParameterTypeRequiredDescription
No parameters.
share_incident_retrospective Write

Share an incident's retrospective Official FireHydrant endpoint: POST /v1/incidents/{incident_id}/retrospectives/share Share incident retrospectives with users or teams

Lua path
app.integrations.firehydrant.share_incident_retrospective
Full name
firehydrant.firehydrant_share_incident_retrospectives
ParameterTypeRequiredDescription
No parameters.
export_incident_retrospective_markdown Write

Export an incident's retrospective(s) as markdown Official FireHydrant endpoint: POST /v1/incidents/{incident_id}/retrospectives/export_markdown Export incident's retrospective(s) as markdown

Lua path
app.integrations.firehydrant.export_incident_retrospective_markdown
Full name
firehydrant.firehydrant_export_incident_retrospectives_markdown
ParameterTypeRequiredDescription
No parameters.
export_incident_retrospective Write

Export an incident's retrospective(s) Official FireHydrant endpoint: POST /v1/incidents/{incident_id}/retrospectives/export Export incident's retrospective(s) using their templates

Lua path
app.integrations.firehydrant.export_incident_retrospective
Full name
firehydrant.firehydrant_export_incident_retrospectives
ParameterTypeRequiredDescription
No parameters.
all_attached_retrospectives_incident Read

All attached retrospectives for an incident Official FireHydrant endpoint: GET /v1/incidents/{incident_id}/retrospectives Retrieve retrospectives attached to an incident

Lua path
app.integrations.firehydrant.all_attached_retrospectives_incident
Full name
firehydrant.firehydrant_list_incident_retrospectives
ParameterTypeRequiredDescription
No parameters.
create_new_retrospective_incident_using_template Write

Create a new retrospective on the incident using the template Official FireHydrant endpoint: POST /v1/incidents/{incident_id}/retrospectives Create a new retrospective for an incident

Lua path
app.integrations.firehydrant.create_new_retrospective_incident_using_template
Full name
firehydrant.firehydrant_create_incident_retrospective
ParameterTypeRequiredDescription
No parameters.
update_retrospective_incident Write

Update a retrospective on the incident Official FireHydrant endpoint: PATCH /v1/incidents/{incident_id}/retrospectives/{retrospective_id} Update a retrospective attached to an incident

Lua path
app.integrations.firehydrant.update_retrospective_incident
Full name
firehydrant.firehydrant_update_incident_retrospective
ParameterTypeRequiredDescription
No parameters.
appends_new_incident_retrospective_field_incident_retrospective Write

Appends a new incident retrospective field to an incident retrospective Official FireHydrant endpoint: PATCH /v1/incidents/{incident_id}/retrospectives/{retrospective_id}/fields Add a new field to an incident retrospective

Lua path
app.integrations.firehydrant.appends_new_incident_retrospective_field_incident_retrospective
Full name
firehydrant.firehydrant_create_incident_retrospective_field
ParameterTypeRequiredDescription
No parameters.
get_retrospective_field Read

Get a retrospective field Official FireHydrant endpoint: GET /v1/incidents/{incident_id}/retrospectives/{retrospective_id}/fields/{field_id} Retrieve a field on an incident retrospective

Lua path
app.integrations.firehydrant.get_retrospective_field
Full name
firehydrant.firehydrant_get_incident_retrospective_field
ParameterTypeRequiredDescription
No parameters.
update_value_retrospective_field Write

Update the value on a retrospective field Official FireHydrant endpoint: PATCH /v1/incidents/{incident_id}/retrospectives/{retrospective_id}/fields/{field_id} Update retrospective field value

Lua path
app.integrations.firehydrant.update_value_retrospective_field
Full name
firehydrant.firehydrant_update_incident_retrospective_field
ParameterTypeRequiredDescription
No parameters.
add_new_dynamic_input_field_retrospective_dynamic_input_group_field Write

Add a new dynamic input field to a retrospective's dynamic input group field Official FireHydrant endpoint: POST /v1/incidents/{incident_id}/retrospectives/{retrospective_id}/fields/{field_id}/inputs Add a new dynamic input field to a dynam

Lua path
app.integrations.firehydrant.add_new_dynamic_input_field_retrospective_dynamic_input_group_field
Full name
firehydrant.firehydrant_create_incident_retrospective_dynamic_input
ParameterTypeRequiredDescription
No parameters.
removes_dynamic_input_from_retrospective_dynamic_input_group_field Write

Removes a dynamic input from a retrospective's dynamic input group field Official FireHydrant endpoint: DELETE /v1/incidents/{incident_id}/retrospectives/{retrospective_id}/fields/{field_id}/inputs Delete a dynamic input on a dynamic input

Lua path
app.integrations.firehydrant.removes_dynamic_input_from_retrospective_dynamic_input_group_field
Full name
firehydrant.firehydrant_delete_incident_retrospective_dynamic_input
ParameterTypeRequiredDescription
No parameters.
list_incident_roles Read

List incident roles Official FireHydrant endpoint: GET /v1/incident_roles List all of the incident roles in the organization

Lua path
app.integrations.firehydrant.list_incident_roles
Full name
firehydrant.firehydrant_list_incident_roles
ParameterTypeRequiredDescription
No parameters.
create_incident_role Write

Create an incident role Official FireHydrant endpoint: POST /v1/incident_roles Create a new incident role

Lua path
app.integrations.firehydrant.create_incident_role
Full name
firehydrant.firehydrant_create_incident_role
ParameterTypeRequiredDescription
No parameters.
get_incident_role Read

Get an incident role Official FireHydrant endpoint: GET /v1/incident_roles/{incident_role_id} Retrieve a single incident role from its ID

Lua path
app.integrations.firehydrant.get_incident_role
Full name
firehydrant.firehydrant_get_incident_role
ParameterTypeRequiredDescription
No parameters.
update_incident_role Write

Update an incident role Official FireHydrant endpoint: PATCH /v1/incident_roles/{incident_role_id} Update a single incident role from its ID

Lua path
app.integrations.firehydrant.update_incident_role
Full name
firehydrant.firehydrant_update_incident_role
ParameterTypeRequiredDescription
No parameters.
archive_incident_role Write

Archive an incident role Official FireHydrant endpoint: DELETE /v1/incident_roles/{incident_role_id} Archives an incident role which will hide it from lists and metrics

Lua path
app.integrations.firehydrant.archive_incident_role
Full name
firehydrant.firehydrant_delete_incident_role
ParameterTypeRequiredDescription
No parameters.
validate_incident_tags Write

Validate incident tags Official FireHydrant endpoint: POST /v1/incident_tags/validate Validate the format of a list of tags

Lua path
app.integrations.firehydrant.validate_incident_tags
Full name
firehydrant.firehydrant_validate_incident_tags
ParameterTypeRequiredDescription
No parameters.
list_incident_tags Read

List incident tags Official FireHydrant endpoint: GET /v1/incident_tags List all of the incident tags in the organization

Lua path
app.integrations.firehydrant.list_incident_tags
Full name
firehydrant.firehydrant_list_incident_tags
ParameterTypeRequiredDescription
No parameters.
list_incident_types Read

List incident types Official FireHydrant endpoint: GET /v1/incident_types List all of the incident types in the organization

Lua path
app.integrations.firehydrant.list_incident_types
Full name
firehydrant.firehydrant_list_incident_types
ParameterTypeRequiredDescription
No parameters.
create_incident_type Write

Create an incident type Official FireHydrant endpoint: POST /v1/incident_types Create a new incident type

Lua path
app.integrations.firehydrant.create_incident_type
Full name
firehydrant.firehydrant_create_incident_type
ParameterTypeRequiredDescription
No parameters.
get_incident_type Read

Get an incident type Official FireHydrant endpoint: GET /v1/incident_types/{id} Retrieve a single incident type from its ID

Lua path
app.integrations.firehydrant.get_incident_type
Full name
firehydrant.firehydrant_get_incident_type
ParameterTypeRequiredDescription
No parameters.
update_incident_type Write

Update an incident type Official FireHydrant endpoint: PATCH /v1/incident_types/{id} Update a single incident type from its ID

Lua path
app.integrations.firehydrant.update_incident_type
Full name
firehydrant.firehydrant_update_incident_type
ParameterTypeRequiredDescription
No parameters.
archive_incident_type Write

Archive an incident type Official FireHydrant endpoint: DELETE /v1/incident_types/{id} Archives an incident type which will hide it from lists and metrics

Lua path
app.integrations.firehydrant.archive_incident_type
Full name
firehydrant.firehydrant_delete_incident_type
ParameterTypeRequiredDescription
No parameters.
list_integrations Read

List integrations Official FireHydrant endpoint: GET /v1/integrations Lists the available and configured integrations

Lua path
app.integrations.firehydrant.list_integrations
Full name
firehydrant.firehydrant_list_integrations
ParameterTypeRequiredDescription
No parameters.
get_integration Read

Get an integration Official FireHydrant endpoint: GET /v1/integrations/{integration_id} Retrieve a single integration

Lua path
app.integrations.firehydrant.get_integration
Full name
firehydrant.firehydrant_get_integration
ParameterTypeRequiredDescription
No parameters.
update_field_mapping Write

Update field mapping Official FireHydrant endpoint: PATCH /v1/integrations/field_maps/{field_map_id} Update field mapping

Lua path
app.integrations.firehydrant.update_field_mapping
Full name
firehydrant.firehydrant_update_field_map
ParameterTypeRequiredDescription
No parameters.
list_available_fields_field_mapping Read

List available fields for field mapping Official FireHydrant endpoint: GET /v1/integrations/field_maps/{field_map_id}/available_fields Get a description of the fields to which data can be mapped

Lua path
app.integrations.firehydrant.list_available_fields_field_mapping
Full name
firehydrant.firehydrant_list_field_map_available_fields
ParameterTypeRequiredDescription
No parameters.
lists_available_and_configured_integrations Read

Lists the available and configured integrations Official FireHydrant endpoint: GET /v1/integrations/authed_providers/{integration_slug}/{connection_id} Lists the available and configured integrations

Lua path
app.integrations.firehydrant.lists_available_and_configured_integrations
Full name
firehydrant.firehydrant_list_authed_providers
ParameterTypeRequiredDescription
No parameters.
get_authed_provider Write

Get an authed provider Official FireHydrant endpoint: PATCH /v1/integrations/authed_providers/{integration_slug}/{connection_id}/{authed_provider_id} Retrieve a single authed provider

Lua path
app.integrations.firehydrant.get_authed_provider
Full name
firehydrant.firehydrant_update_authed_provider
ParameterTypeRequiredDescription
No parameters.
list_integration_connections Read

List integration connections Official FireHydrant endpoint: GET /v1/integrations/connections List available integration connections

Lua path
app.integrations.firehydrant.list_integration_connections
Full name
firehydrant.firehydrant_list_connections
ParameterTypeRequiredDescription
No parameters.
create_new_integration_connection Write

Create a new integration connection Official FireHydrant endpoint: POST /v1/integrations/connections/{slug} Create a new integration connection

Lua path
app.integrations.firehydrant.create_new_integration_connection
Full name
firehydrant.firehydrant_create_connection
ParameterTypeRequiredDescription
No parameters.
refresh_integration_connection Write

Refresh an integration connection Official FireHydrant endpoint: PATCH /v1/integrations/connections/{slug}/{connection_id}/refresh Refresh the integration connection with the provided data

Lua path
app.integrations.firehydrant.refresh_integration_connection
Full name
firehydrant.firehydrant_refresh_connection
ParameterTypeRequiredDescription
No parameters.
update_integration_connection Write

Update an integration connection Official FireHydrant endpoint: PATCH /v1/integrations/connections/{slug}/{connection_id} Update the integration connection with the provided data

Lua path
app.integrations.firehydrant.update_integration_connection
Full name
firehydrant.firehydrant_update_connection
ParameterTypeRequiredDescription
No parameters.
get_integration_connection_status Read

Get integration connection status Official FireHydrant endpoint: GET /v1/integrations/statuses Retrieve overall integration connection status

Lua path
app.integrations.firehydrant.get_integration_connection_status
Full name
firehydrant.firehydrant_list_connection_statuses
ParameterTypeRequiredDescription
No parameters.
get_integration_connection_status Read

Get an integration connection status Official FireHydrant endpoint: GET /v1/integrations/statuses/{slug} Retrieve a single integration connection status

Lua path
app.integrations.firehydrant.get_integration_connection_status
Full name
firehydrant.firehydrant_list_connection_statuses_by_slug
ParameterTypeRequiredDescription
No parameters.
get_integration_connection_status Read

Get an integration connection status Official FireHydrant endpoint: GET /v1/integrations/statuses/{slug}/{by_connection_id} Retrieve a single integration connection status

Lua path
app.integrations.firehydrant.get_integration_connection_status
Full name
firehydrant.firehydrant_list_connection_statuses_by_slug_and_id
ParameterTypeRequiredDescription
No parameters.
list_aws_connections Read

List AWS connections Official FireHydrant endpoint: GET /v1/integrations/aws/connections Lists the available and configured AWS integration connections for the authenticated organization.

Lua path
app.integrations.firehydrant.list_aws_connections
Full name
firehydrant.firehydrant_list_aws_connections
ParameterTypeRequiredDescription
No parameters.
get_aws_connection Read

Get an AWS connection Official FireHydrant endpoint: GET /v1/integrations/aws/connections/{id} Retrieves the information about the AWS connection.

Lua path
app.integrations.firehydrant.get_aws_connection
Full name
firehydrant.firehydrant_get_aws_connection
ParameterTypeRequiredDescription
No parameters.
update_aws_connection Write

Update an AWS connection Official FireHydrant endpoint: PATCH /v1/integrations/aws/connections/{id} Update the AWS connection with the provided data.

Lua path
app.integrations.firehydrant.update_aws_connection
Full name
firehydrant.firehydrant_update_aws_connection
ParameterTypeRequiredDescription
No parameters.
list_cloudtrail_batches Read

List CloudTrail batches Official FireHydrant endpoint: GET /v1/integrations/aws/cloudtrail_batches Lists CloudTrail batches for the authenticated organization.

Lua path
app.integrations.firehydrant.list_cloudtrail_batches
Full name
firehydrant.firehydrant_list_aws_cloudtrail_batches
ParameterTypeRequiredDescription
No parameters.
get_cloudtrail_batch Read

Get a CloudTrail batch Official FireHydrant endpoint: GET /v1/integrations/aws/cloudtrail_batches/{id} Retrieve a single CloudTrail batch.

Lua path
app.integrations.firehydrant.get_cloudtrail_batch
Full name
firehydrant.firehydrant_get_aws_cloudtrail_batch
ParameterTypeRequiredDescription
No parameters.
update_cloudtrail_batch Write

Update a CloudTrail batch Official FireHydrant endpoint: PATCH /v1/integrations/aws/cloudtrail_batches/{id} Update a CloudTrail batch with new information.

Lua path
app.integrations.firehydrant.update_cloudtrail_batch
Full name
firehydrant.firehydrant_update_aws_cloudtrail_batch
ParameterTypeRequiredDescription
No parameters.
list_events_aws_cloudtrail_batch Read

List events for an AWS CloudTrail batch Official FireHydrant endpoint: GET /v1/integrations/aws/cloudtrail_batches/{id}/events List events for an AWS CloudTrail batch

Lua path
app.integrations.firehydrant.list_events_aws_cloudtrail_batch
Full name
firehydrant.firehydrant_list_aws_cloudtrail_batch_events
ParameterTypeRequiredDescription
No parameters.
list_confluence_spaces Read

List Confluence spaces Official FireHydrant endpoint: GET /v1/integrations/confluence_cloud/connections/{id}/space/search Lists available space keys for the Confluence integration connection.

Lua path
app.integrations.firehydrant.list_confluence_spaces
Full name
firehydrant.firehydrant_search_confluence_spaces
ParameterTypeRequiredDescription
No parameters.
list_slack_workspaces Read

List Slack workspaces Official FireHydrant endpoint: GET /v1/integrations/slack/connections/{connection_id}/workspaces Lists all Slack workspaces

Lua path
app.integrations.firehydrant.list_slack_workspaces
Full name
firehydrant.firehydrant_list_slack_workspaces
ParameterTypeRequiredDescription
No parameters.
list_slack_user_groups Read

List Slack user groups Official FireHydrant endpoint: GET /v1/integrations/slack/usergroups Lists all Slack user groups

Lua path
app.integrations.firehydrant.list_slack_user_groups
Full name
firehydrant.firehydrant_list_slack_usergroups
ParameterTypeRequiredDescription
No parameters.
list_slack_emoji_actions Read

List Slack emoji actions Official FireHydrant endpoint: GET /v1/integrations/slack/connections/{connection_id}/emoji_actions Lists Slack emoji actions

Lua path
app.integrations.firehydrant.list_slack_emoji_actions
Full name
firehydrant.firehydrant_list_slack_emoji_actions
ParameterTypeRequiredDescription
No parameters.
create_new_slack_emoji_action Write

Create a new Slack emoji action Official FireHydrant endpoint: POST /v1/integrations/slack/connections/{connection_id}/emoji_actions Creates a new Slack emoji action

Lua path
app.integrations.firehydrant.create_new_slack_emoji_action
Full name
firehydrant.firehydrant_create_slack_emoji_action
ParameterTypeRequiredDescription
No parameters.
get_slack_emoji_action Read

Get a Slack emoji action Official FireHydrant endpoint: GET /v1/integrations/slack/connections/{connection_id}/emoji_actions/{emoji_action_id} Retrieves a Slack emoji action

Lua path
app.integrations.firehydrant.get_slack_emoji_action
Full name
firehydrant.firehydrant_get_slack_emoji_action
ParameterTypeRequiredDescription
No parameters.
update_slack_emoji_action Write

Update a Slack emoji action Official FireHydrant endpoint: PATCH /v1/integrations/slack/connections/{connection_id}/emoji_actions/{emoji_action_id} Updates a Slack emoji action

Lua path
app.integrations.firehydrant.update_slack_emoji_action
Full name
firehydrant.firehydrant_update_slack_emoji_action
ParameterTypeRequiredDescription
No parameters.
delete_slack_emoji_action Write

Delete a Slack emoji action Official FireHydrant endpoint: DELETE /v1/integrations/slack/connections/{connection_id}/emoji_actions/{emoji_action_id} Deletes a Slack emoji action

Lua path
app.integrations.firehydrant.delete_slack_emoji_action
Full name
firehydrant.firehydrant_delete_slack_emoji_action
ParameterTypeRequiredDescription
No parameters.
list_statuspage_connections Read

List Statuspage connections Official FireHydrant endpoint: GET /v1/integrations/statuspage/connections Lists the available and configured Statuspage integrations connections for the authenticated organization.

Lua path
app.integrations.firehydrant.list_statuspage_connections
Full name
firehydrant.firehydrant_list_statuspage_connections
ParameterTypeRequiredDescription
No parameters.
get_statuspage_connection Read

Get a Statuspage connection Official FireHydrant endpoint: GET /v1/integrations/statuspage/connections/{connection_id} Retrieve the information about the Statuspage connection.

Lua path
app.integrations.firehydrant.get_statuspage_connection
Full name
firehydrant.firehydrant_get_statuspage_connection
ParameterTypeRequiredDescription
No parameters.
update_statuspage_connection Write

Update a Statuspage connection Official FireHydrant endpoint: PATCH /v1/integrations/statuspage/connections/{connection_id} Update the given Statuspage integration connection.

Lua path
app.integrations.firehydrant.update_statuspage_connection
Full name
firehydrant.firehydrant_update_statuspage_connection
ParameterTypeRequiredDescription
No parameters.
delete_statuspage_connection Write

Delete a Statuspage connection Official FireHydrant endpoint: DELETE /v1/integrations/statuspage/connections/{connection_id} Deletes the given Statuspage integration connection.

Lua path
app.integrations.firehydrant.delete_statuspage_connection
Full name
firehydrant.firehydrant_delete_statuspage_connection
ParameterTypeRequiredDescription
No parameters.
list_statuspage_pages_connection Read

List StatusPage pages for a connection Official FireHydrant endpoint: GET /v1/integrations/statuspage/connections/{connection_id}/pages Lists available page IDs for the Statuspage integration connection.

Lua path
app.integrations.firehydrant.list_statuspage_pages_connection
Full name
firehydrant.firehydrant_list_statuspage_connection_pages
ParameterTypeRequiredDescription
No parameters.
search_zendesk_tickets Read

Search for Zendesk tickets Official FireHydrant endpoint: GET /v1/integrations/zendesk/{connection_id}/tickets/search Search for Zendesk tickets

Lua path
app.integrations.firehydrant.search_zendesk_tickets
Full name
firehydrant.firehydrant_search_zendesk_tickets
ParameterTypeRequiredDescription
No parameters.
search_zendesk_tickets Read

Search for Zendesk tickets Official FireHydrant endpoint: GET /v1/integrations/zendesk/search Search for Zendesk tickets

Lua path
app.integrations.firehydrant.search_zendesk_tickets
Full name
firehydrant.firehydrant_get_zendesk_customer_support_issue
ParameterTypeRequiredDescription
No parameters.
list_users Read

List users Official FireHydrant endpoint: GET /v1/users Retrieve a list of all users in an organization

Lua path
app.integrations.firehydrant.list_users
Full name
firehydrant.firehydrant_list_users
ParameterTypeRequiredDescription
No parameters.
get_user Read

Get a user Official FireHydrant endpoint: GET /v1/users/{id} Retrieve a single user by ID

Lua path
app.integrations.firehydrant.get_user
Full name
firehydrant.firehydrant_get_user
ParameterTypeRequiredDescription
No parameters.
list_services_owned_by_user_teams Read

List services owned by a user's teams Official FireHydrant endpoint: GET /v1/users/{id}/services Retrieves a list of services owned by the teams a user is on

Lua path
app.integrations.firehydrant.list_services_owned_by_user_teams
Full name
firehydrant.firehydrant_list_user_owned_services
ParameterTypeRequiredDescription
No parameters.
get_currently_authenticated_user Read

Get the currently authenticated user Official FireHydrant endpoint: GET /v1/current_user Retrieve the current user

Lua path
app.integrations.firehydrant.get_currently_authenticated_user
Full name
firehydrant.firehydrant_get_current_user
ParameterTypeRequiredDescription
No parameters.
list_permissions Read

List permissions Official FireHydrant endpoint: GET /v1/permissions List all permissions in the organization

Lua path
app.integrations.firehydrant.list_permissions
Full name
firehydrant.firehydrant_list_permissions
ParameterTypeRequiredDescription
No parameters.
get_all_permissions_current_user Read

Get all permissions for the current user Official FireHydrant endpoint: GET /v1/permissions/current_user Get all permissions for the current user

Lua path
app.integrations.firehydrant.get_all_permissions_current_user
Full name
firehydrant.firehydrant_list_current_user_permissions
ParameterTypeRequiredDescription
No parameters.
get_all_permissions_team Read

Get all permissions for a team Official FireHydrant endpoint: GET /v1/permissions/team Get all permissions for a team

Lua path
app.integrations.firehydrant.get_all_permissions_team
Full name
firehydrant.firehydrant_list_team_permissions
ParameterTypeRequiredDescription
No parameters.
get_mean_time_metrics_incidents Read

Get mean time metrics for incidents Official FireHydrant endpoint: GET /v1/reports/mean_time Returns a report with time bucketed analytics data

Lua path
app.integrations.firehydrant.get_mean_time_metrics_incidents
Full name
firehydrant.firehydrant_get_mean_time_report
ParameterTypeRequiredDescription
No parameters.
list_retrospective_reports Read

List retrospective reports Official FireHydrant endpoint: GET /v1/retrospectives List all retrospective reports

Lua path
app.integrations.firehydrant.list_retrospective_reports
Full name
firehydrant.firehydrant_list_retrospectives
ParameterTypeRequiredDescription
No parameters.
get_all_roles Read

Get all roles Official FireHydrant endpoint: GET /v1/roles Get all roles in the organization

Lua path
app.integrations.firehydrant.get_all_roles
Full name
firehydrant.firehydrant_list_roles
ParameterTypeRequiredDescription
No parameters.
create_role Write

Create a role Official FireHydrant endpoint: POST /v1/roles Create a new role

Lua path
app.integrations.firehydrant.create_role
Full name
firehydrant.firehydrant_create_role
ParameterTypeRequiredDescription
No parameters.
get_role Read

Get a role Official FireHydrant endpoint: GET /v1/roles/{id} Get a role

Lua path
app.integrations.firehydrant.get_role
Full name
firehydrant.firehydrant_get_role
ParameterTypeRequiredDescription
No parameters.
update_role Write

Update a role Official FireHydrant endpoint: PATCH /v1/roles/{id} Update a role

Lua path
app.integrations.firehydrant.update_role
Full name
firehydrant.firehydrant_update_role
ParameterTypeRequiredDescription
No parameters.
delete_role Write

Delete a role Official FireHydrant endpoint: DELETE /v1/roles/{id} Delete a role

Lua path
app.integrations.firehydrant.delete_role
Full name
firehydrant.firehydrant_delete_role
ParameterTypeRequiredDescription
No parameters.
list_ticket_task_and_follow_up_creation_and_completion_metrics Read

List ticket task and follow up creation and completion metrics Official FireHydrant endpoint: GET /v1/metrics/ticket_funnel Returns a report with task and follow up creation and completion data

Lua path
app.integrations.firehydrant.list_ticket_task_and_follow_up_creation_and_completion_metrics
Full name
firehydrant.firehydrant_list_ticket_funnel_metrics
ParameterTypeRequiredDescription
No parameters.
list_retrospective_metrics Read

List retrospective metrics Official FireHydrant endpoint: GET /v1/metrics/retrospectives Returns a report with retrospective analytics data

Lua path
app.integrations.firehydrant.list_retrospective_metrics
Full name
firehydrant.firehydrant_list_retrospective_metrics
ParameterTypeRequiredDescription
No parameters.
list_milestone_funnel_metrics Read

List milestone funnel metrics Official FireHydrant endpoint: GET /v1/metrics/milestone_funnel Returns a report with time bucketed milestone data

Lua path
app.integrations.firehydrant.list_milestone_funnel_metrics
Full name
firehydrant.firehydrant_list_milestone_funnel_metrics
ParameterTypeRequiredDescription
No parameters.
list_user_metrics Read

List user metrics Official FireHydrant endpoint: GET /v1/metrics/user_involvements Returns a report with time bucketed analytics data

Lua path
app.integrations.firehydrant.list_user_metrics
Full name
firehydrant.firehydrant_list_user_involvement_metrics
ParameterTypeRequiredDescription
No parameters.
list_incident_metrics_and_analytics Read

List incident metrics and analytics Official FireHydrant endpoint: GET /v1/metrics/incidents Returns a report with time bucketed analytics data

Lua path
app.integrations.firehydrant.list_incident_metrics_and_analytics
Full name
firehydrant.firehydrant_list_incident_metrics
ParameterTypeRequiredDescription
No parameters.
get_infrastructure_metrics Read

Get infrastructure metrics Official FireHydrant endpoint: GET /v1/metrics/mttx Fetch infrastructure metrics based on custom query

Lua path
app.integrations.firehydrant.get_infrastructure_metrics
Full name
firehydrant.firehydrant_list_mttx_metrics
ParameterTypeRequiredDescription
No parameters.
list_metrics_component_type Read

List metrics for a component type Official FireHydrant endpoint: GET /v1/metrics/{infra_type} Returns metrics for all components of a given type

Lua path
app.integrations.firehydrant.list_metrics_component_type
Full name
firehydrant.firehydrant_list_infrastructure_type_metrics
ParameterTypeRequiredDescription
No parameters.
get_metrics_component Read

Get metrics for a component Official FireHydrant endpoint: GET /v1/metrics/{infra_type}/{infra_id} Return metrics for a specific component

Lua path
app.integrations.firehydrant.get_metrics_component
Full name
firehydrant.firehydrant_list_infrastructure_metrics
ParameterTypeRequiredDescription
No parameters.
list_runbook_actions Read

List runbook actions Official FireHydrant endpoint: GET /v1/runbooks/actions List all runbook actions available through your connected integrations

Lua path
app.integrations.firehydrant.list_runbook_actions
Full name
firehydrant.firehydrant_list_runbook_actions
ParameterTypeRequiredDescription
No parameters.
list_runbook_executions Read

List runbook executions Official FireHydrant endpoint: GET /v1/runbooks/executions List all runbook executions across all runbooks

Lua path
app.integrations.firehydrant.list_runbook_executions
Full name
firehydrant.firehydrant_list_runbook_executions
ParameterTypeRequiredDescription
No parameters.
create_runbook_execution Write

Create a runbook execution Official FireHydrant endpoint: POST /v1/runbooks/executions Attaches a runbook to an incident and executes it

Lua path
app.integrations.firehydrant.create_runbook_execution
Full name
firehydrant.firehydrant_create_runbook_execution
ParameterTypeRequiredDescription
No parameters.
get_runbook_execution Read

Get a runbook execution Official FireHydrant endpoint: GET /v1/runbooks/executions/{execution_id} Retrieve a runbook execution by ID

Lua path
app.integrations.firehydrant.get_runbook_execution
Full name
firehydrant.firehydrant_get_runbook_execution
ParameterTypeRequiredDescription
No parameters.
terminate_runbook_execution Write

Terminate a runbook execution Official FireHydrant endpoint: DELETE /v1/runbooks/executions/{execution_id} Terminates a runbook execution, preventing any further steps from being executed

Lua path
app.integrations.firehydrant.terminate_runbook_execution
Full name
firehydrant.firehydrant_delete_runbook_execution
ParameterTypeRequiredDescription
No parameters.
update_runbook_step_execution Write

Update a runbook step execution Official FireHydrant endpoint: PUT /v1/runbooks/executions/{execution_id}/steps/{step_id} Updates a runbook step execution, especially for changing the state of a step execution.

Lua path
app.integrations.firehydrant.update_runbook_step_execution
Full name
firehydrant.firehydrant_update_runbook_execution_step
ParameterTypeRequiredDescription
No parameters.
get_step_bash_script Read

Get a step's bash script Official FireHydrant endpoint: GET /v1/runbooks/executions/{execution_id}/steps/{step_id}/script Retrieves the bash script from a \"script\" step.

Lua path
app.integrations.firehydrant.get_step_bash_script
Full name
firehydrant.firehydrant_get_runbook_execution_step_script
ParameterTypeRequiredDescription
No parameters.
update_script_step_execution_status Write

Update a script step's execution status Official FireHydrant endpoint: PUT /v1/runbooks/executions/{execution_id}/steps/{step_id}/script/{state} Updates the execution's step.

Lua path
app.integrations.firehydrant.update_script_step_execution_status
Full name
firehydrant.firehydrant_update_runbook_execution_step_script
ParameterTypeRequiredDescription
No parameters.
list_select_options_runbook_integration_action_field Read

List select options for a runbook integration action field Official FireHydrant endpoint: GET /v1/runbooks/select_options/{integration_slug}/{action_slug}/{field} List select options for a runbook integration action field

Lua path
app.integrations.firehydrant.list_select_options_runbook_integration_action_field
Full name
firehydrant.firehydrant_get_runbook_action_field_options
ParameterTypeRequiredDescription
No parameters.
list_runbooks Read

List runbooks Official FireHydrant endpoint: GET /v1/runbooks Lists all available runbooks.

Lua path
app.integrations.firehydrant.list_runbooks
Full name
firehydrant.firehydrant_list_runbooks
ParameterTypeRequiredDescription
No parameters.
create_runbook Write

Create a runbook Official FireHydrant endpoint: POST /v1/runbooks Create a new runbook for use with incidents.

Lua path
app.integrations.firehydrant.create_runbook
Full name
firehydrant.firehydrant_create_runbook
ParameterTypeRequiredDescription
No parameters.
get_runbook Read

Get a runbook Official FireHydrant endpoint: GET /v1/runbooks/{runbook_id} Get a runbook and all its configuration

Lua path
app.integrations.firehydrant.get_runbook
Full name
firehydrant.firehydrant_get_runbook
ParameterTypeRequiredDescription
No parameters.
update_runbook Write

Update a runbook Official FireHydrant endpoint: PUT /v1/runbooks/{runbook_id} Update a runbook and any attachment rules associated with it. This endpoint is used to configure nearly everything about a runbook, including but not limited to t

Lua path
app.integrations.firehydrant.update_runbook
Full name
firehydrant.firehydrant_update_runbook
ParameterTypeRequiredDescription
No parameters.
delete_runbook Write

Delete a runbook Official FireHydrant endpoint: DELETE /v1/runbooks/{runbook_id} Delete a runbook and make it unavailable for any future incidents.

Lua path
app.integrations.firehydrant.delete_runbook
Full name
firehydrant.firehydrant_delete_runbook
ParameterTypeRequiredDescription
No parameters.
list_runbook_audits Read

List runbook audits Official FireHydrant endpoint: GET /v1/runbook_audits This endpoint is deprecated.

Lua path
app.integrations.firehydrant.list_runbook_audits
Full name
firehydrant.firehydrant_list_runbook_audits
ParameterTypeRequiredDescription
No parameters.
list_audit_events Read

List audit events Official FireHydrant endpoint: GET /v1/audit_events List audit events

Lua path
app.integrations.firehydrant.list_audit_events
Full name
firehydrant.firehydrant_list_audit_events
ParameterTypeRequiredDescription
No parameters.
get_single_audit_event Read

Get a single audit event Official FireHydrant endpoint: GET /v1/audit_events/{id} Get a single audit event

Lua path
app.integrations.firehydrant.get_single_audit_event
Full name
firehydrant.firehydrant_get_audit_event
ParameterTypeRequiredDescription
No parameters.
list_status_pages Read

List status pages Official FireHydrant endpoint: GET /v1/nunc_connections Lists the information displayed as part of your FireHydrant hosted status pages.

Lua path
app.integrations.firehydrant.list_status_pages
Full name
firehydrant.firehydrant_list_nunc_connections
ParameterTypeRequiredDescription
No parameters.
create_status_page Write

Create a status page Official FireHydrant endpoint: POST /v1/nunc_connections Create a new FireHydrant hosted status page for customer facing statuses.

Lua path
app.integrations.firehydrant.create_status_page
Full name
firehydrant.firehydrant_create_nunc_connection
ParameterTypeRequiredDescription
No parameters.
list_status_page_subscribers Read

List status page subscribers Official FireHydrant endpoint: GET /v1/nunc_connections/{nunc_connection_id}/subscribers Retrieves the list of subscribers for a status page.

Lua path
app.integrations.firehydrant.list_status_page_subscribers
Full name
firehydrant.firehydrant_list_email_subscribers
ParameterTypeRequiredDescription
No parameters.
add_subscribers_status_page Write

Add subscribers to a status page Official FireHydrant endpoint: POST /v1/nunc_connections/{nunc_connection_id}/subscribers Subscribes a comma-separated string of emails to status page updates

Lua path
app.integrations.firehydrant.add_subscribers_status_page
Full name
firehydrant.firehydrant_create_email_subscriber
ParameterTypeRequiredDescription
No parameters.
remove_subscribers_from_status_page Write

Remove subscribers from a status page Official FireHydrant endpoint: DELETE /v1/nunc_connections/{nunc_connection_id}/subscribers Unsubscribes one or more status page subscribers.

Lua path
app.integrations.firehydrant.remove_subscribers_from_status_page
Full name
firehydrant.firehydrant_delete_email_subscriber
ParameterTypeRequiredDescription
No parameters.
get_status_page Read

Get a status page Official FireHydrant endpoint: GET /v1/nunc_connections/{nunc_connection_id} Retrieve the information displayed as part of your FireHydrant hosted status page.

Lua path
app.integrations.firehydrant.get_status_page
Full name
firehydrant.firehydrant_get_nunc_connection
ParameterTypeRequiredDescription
No parameters.
update_status_page Write

Update a status page Official FireHydrant endpoint: PUT /v1/nunc_connections/{nunc_connection_id} Update your company's information and other components in the specified FireHydrant hosted status page.

Lua path
app.integrations.firehydrant.update_status_page
Full name
firehydrant.firehydrant_update_nunc_connection
ParameterTypeRequiredDescription
No parameters.
delete_status_page Write

Delete a status page Official FireHydrant endpoint: DELETE /v1/nunc_connections/{nunc_connection_id} Delete a FireHydrant hosted status page, stopping updates of your incidents to it.

Lua path
app.integrations.firehydrant.delete_status_page
Full name
firehydrant.firehydrant_delete_nunc_connection
ParameterTypeRequiredDescription
No parameters.
unpublish_status_page Write

Unpublish a status page Official FireHydrant endpoint: POST /v1/nunc_connections/{nunc_connection_id}/unpublish Unpublish a FireHydrant hosted status page

Lua path
app.integrations.firehydrant.unpublish_status_page
Full name
firehydrant.firehydrant_unpublish_nunc_connection
ParameterTypeRequiredDescription
No parameters.
publish_status_page Write

Publish a status page Official FireHydrant endpoint: POST /v1/nunc_connections/{nunc_connection_id}/publish Publish a FireHydrant hosted status page

Lua path
app.integrations.firehydrant.publish_status_page
Full name
firehydrant.firehydrant_publish_nunc_connection
ParameterTypeRequiredDescription
No parameters.
update_status_page_component_group Write

Update a status page component group Official FireHydrant endpoint: PATCH /v1/nunc_connections/{nunc_connection_id}/component_groups/{group_id} Update a component group to be displayed on a FireHydrant status page

Lua path
app.integrations.firehydrant.update_status_page_component_group
Full name
firehydrant.firehydrant_update_nunc_component_group
ParameterTypeRequiredDescription
No parameters.
delete_status_page_component_group Write

Delete a status page component group Official FireHydrant endpoint: DELETE /v1/nunc_connections/{nunc_connection_id}/component_groups/{group_id} Delete a component group displayed on a FireHydrant status page

Lua path
app.integrations.firehydrant.delete_status_page_component_group
Full name
firehydrant.firehydrant_delete_nunc_component_group
ParameterTypeRequiredDescription
No parameters.
create_component_group_status_page Write

Create a component group for a status page Official FireHydrant endpoint: POST /v1/nunc_connections/{nunc_connection_id}/component_groups Add a component group to be displayed on a FireHydrant status page

Lua path
app.integrations.firehydrant.create_component_group_status_page
Full name
firehydrant.firehydrant_create_nunc_component_group
ParameterTypeRequiredDescription
No parameters.
upload_image_status_page Write

Upload an image for a status page Official FireHydrant endpoint: PUT /v1/nunc_connections/{nunc_connection_id}/images/{type} Add or replace an image attached to a FireHydrant status page

Lua path
app.integrations.firehydrant.upload_image_status_page
Full name
firehydrant.firehydrant_update_nunc_image
ParameterTypeRequiredDescription
No parameters.
delete_image_from_status_page Write

Delete an image from a status page Official FireHydrant endpoint: DELETE /v1/nunc_connections/{nunc_connection_id}/images/{type} Delete an image attached to a FireHydrant status page

Lua path
app.integrations.firehydrant.delete_image_from_status_page
Full name
firehydrant.firehydrant_delete_nunc_image
ParameterTypeRequiredDescription
No parameters.
list_saved_searches Read

List saved searches Official FireHydrant endpoint: GET /v1/saved_searches/{resource_type} Lists saved searches

Lua path
app.integrations.firehydrant.list_saved_searches
Full name
firehydrant.firehydrant_list_saved_searches
ParameterTypeRequiredDescription
No parameters.
list_measurement_definitions Read

List measurement definitions Official FireHydrant endpoint: GET /v1/lifecycles/measurement_definitions List all of the measurement definitions in the organization

Lua path
app.integrations.firehydrant.list_measurement_definitions
Full name
firehydrant.firehydrant_list_lifecycle_measurement_definitions
ParameterTypeRequiredDescription
No parameters.
create_measurement_definition Write

Create a measurement definition Official FireHydrant endpoint: POST /v1/lifecycles/measurement_definitions Create a new measurement definition

Lua path
app.integrations.firehydrant.create_measurement_definition
Full name
firehydrant.firehydrant_create_lifecycle_measurement_definition
ParameterTypeRequiredDescription
No parameters.
get_measurement_definition Read

Get a measurement definition Official FireHydrant endpoint: GET /v1/lifecycles/measurement_definitions/{measurement_definition_id} Retrieve a single measurement definition from its ID

Lua path
app.integrations.firehydrant.get_measurement_definition
Full name
firehydrant.firehydrant_get_lifecycle_measurement_definition
ParameterTypeRequiredDescription
No parameters.
update_measurement_definition Write

Update a measurement definition Official FireHydrant endpoint: PATCH /v1/lifecycles/measurement_definitions/{measurement_definition_id} Update a single measurement definition from its ID

Lua path
app.integrations.firehydrant.update_measurement_definition
Full name
firehydrant.firehydrant_update_lifecycle_measurement_definition
ParameterTypeRequiredDescription
No parameters.
archive_measurement_definition Write

Archive a measurement definition Official FireHydrant endpoint: DELETE /v1/lifecycles/measurement_definitions/{measurement_definition_id} Archives a measurement definition which will hide it from lists and metrics

Lua path
app.integrations.firehydrant.archive_measurement_definition
Full name
firehydrant.firehydrant_delete_lifecycle_measurement_definition
ParameterTypeRequiredDescription
No parameters.
list_phases_and_milestones Read

List phases and milestones Official FireHydrant endpoint: GET /v1/lifecycles/phases List all of the lifecycle phases and milestones in the organization

Lua path
app.integrations.firehydrant.list_phases_and_milestones
Full name
firehydrant.firehydrant_list_lifecycle_phases
ParameterTypeRequiredDescription
No parameters.
create_milestone Write

Create a milestone Official FireHydrant endpoint: POST /v1/lifecycles/milestones Create a new milestone

Lua path
app.integrations.firehydrant.create_milestone
Full name
firehydrant.firehydrant_create_lifecycle_milestone
ParameterTypeRequiredDescription
No parameters.
update_milestone Write

Update a milestone Official FireHydrant endpoint: PATCH /v1/lifecycles/milestones/{milestone_id} Update a milestone

Lua path
app.integrations.firehydrant.update_milestone
Full name
firehydrant.firehydrant_update_lifecycle_milestone
ParameterTypeRequiredDescription
No parameters.
delete_milestone Write

Delete a milestone Official FireHydrant endpoint: DELETE /v1/lifecycles/milestones/{milestone_id} Delete a milestone

Lua path
app.integrations.firehydrant.delete_milestone
Full name
firehydrant.firehydrant_delete_lifecycle_milestone
ParameterTypeRequiredDescription
No parameters.
list_priorities Read

List priorities Official FireHydrant endpoint: GET /v1/priorities Lists priorities

Lua path
app.integrations.firehydrant.list_priorities
Full name
firehydrant.firehydrant_list_priorities
ParameterTypeRequiredDescription
No parameters.
create_priority Write

Create a priority Official FireHydrant endpoint: POST /v1/priorities Create a new priority

Lua path
app.integrations.firehydrant.create_priority
Full name
firehydrant.firehydrant_create_priority
ParameterTypeRequiredDescription
No parameters.
get_priority Read

Get a priority Official FireHydrant endpoint: GET /v1/priorities/{priority_slug} Retrieve a specific priority

Lua path
app.integrations.firehydrant.get_priority
Full name
firehydrant.firehydrant_get_priority
ParameterTypeRequiredDescription
No parameters.
update_priority Write

Update a priority Official FireHydrant endpoint: PATCH /v1/priorities/{priority_slug} Update a specific priority

Lua path
app.integrations.firehydrant.update_priority
Full name
firehydrant.firehydrant_update_priority
ParameterTypeRequiredDescription
No parameters.
delete_priority Write

Delete a priority Official FireHydrant endpoint: DELETE /v1/priorities/{priority_slug} Delete a specific priority

Lua path
app.integrations.firehydrant.delete_priority
Full name
firehydrant.firehydrant_delete_priority
ParameterTypeRequiredDescription
No parameters.
list_severities Read

List severities Official FireHydrant endpoint: GET /v1/severities Lists severities

Lua path
app.integrations.firehydrant.list_severities
Full name
firehydrant.firehydrant_list_severities
ParameterTypeRequiredDescription
No parameters.
create_severity Write

Create a severity Official FireHydrant endpoint: POST /v1/severities Create a new severity

Lua path
app.integrations.firehydrant.create_severity
Full name
firehydrant.firehydrant_create_severity
ParameterTypeRequiredDescription
No parameters.
get_severity Read

Get a severity Official FireHydrant endpoint: GET /v1/severities/{severity_slug} Retrieve a specific severity

Lua path
app.integrations.firehydrant.get_severity
Full name
firehydrant.firehydrant_get_severity
ParameterTypeRequiredDescription
No parameters.
update_severity Write

Update a severity Official FireHydrant endpoint: PATCH /v1/severities/{severity_slug} Update a specific severity

Lua path
app.integrations.firehydrant.update_severity
Full name
firehydrant.firehydrant_update_severity
ParameterTypeRequiredDescription
No parameters.
delete_severity Write

Delete a severity Official FireHydrant endpoint: DELETE /v1/severities/{severity_slug} Delete a specific severity

Lua path
app.integrations.firehydrant.delete_severity
Full name
firehydrant.firehydrant_delete_severity
ParameterTypeRequiredDescription
No parameters.
get_severity_matrix Read

Get severity matrix Official FireHydrant endpoint: GET /v1/severity_matrix Retrieve the Severity matrix for your organization and its components and configured severities.

Lua path
app.integrations.firehydrant.get_severity_matrix
Full name
firehydrant.firehydrant_get_severity_matrix
ParameterTypeRequiredDescription
No parameters.
update_severity_matrix Write

Update severity matrix Official FireHydrant endpoint: PATCH /v1/severity_matrix Update available severities and impacts in your organization's severity matrix.

Lua path
app.integrations.firehydrant.update_severity_matrix
Full name
firehydrant.firehydrant_update_severity_matrix
ParameterTypeRequiredDescription
No parameters.
list_severity_matrix_conditions Read

List severity matrix conditions Official FireHydrant endpoint: GET /v1/severity_matrix/conditions Lists conditions

Lua path
app.integrations.firehydrant.list_severity_matrix_conditions
Full name
firehydrant.firehydrant_list_severity_matrix_conditions
ParameterTypeRequiredDescription
No parameters.
create_severity_matrix_condition Write

Create a severity matrix condition Official FireHydrant endpoint: POST /v1/severity_matrix/conditions Create a new condition

Lua path
app.integrations.firehydrant.create_severity_matrix_condition
Full name
firehydrant.firehydrant_create_severity_matrix_condition
ParameterTypeRequiredDescription
No parameters.
get_severity_matrix_condition Read

Get a severity matrix condition Official FireHydrant endpoint: GET /v1/severity_matrix/conditions/{condition_id} Retrieve a specific condition

Lua path
app.integrations.firehydrant.get_severity_matrix_condition
Full name
firehydrant.firehydrant_get_severity_matrix_condition
ParameterTypeRequiredDescription
No parameters.
update_severity_matrix_condition Write

Update a severity matrix condition Official FireHydrant endpoint: PATCH /v1/severity_matrix/conditions/{condition_id} Update a severity matrix condition

Lua path
app.integrations.firehydrant.update_severity_matrix_condition
Full name
firehydrant.firehydrant_update_severity_matrix_condition
ParameterTypeRequiredDescription
No parameters.
delete_severity_matrix_condition Write

Delete a severity matrix condition Official FireHydrant endpoint: DELETE /v1/severity_matrix/conditions/{condition_id} Delete a specific condition

Lua path
app.integrations.firehydrant.delete_severity_matrix_condition
Full name
firehydrant.firehydrant_delete_severity_matrix_condition
ParameterTypeRequiredDescription
No parameters.
list_severity_matrix_impacts Read

List severity matrix impacts Official FireHydrant endpoint: GET /v1/severity_matrix/impacts Lists impacts

Lua path
app.integrations.firehydrant.list_severity_matrix_impacts
Full name
firehydrant.firehydrant_list_severity_matrix_impacts
ParameterTypeRequiredDescription
No parameters.
create_severity_matrix_impact Write

Create a severity matrix impact Official FireHydrant endpoint: POST /v1/severity_matrix/impacts Create a new impact

Lua path
app.integrations.firehydrant.create_severity_matrix_impact
Full name
firehydrant.firehydrant_create_severity_matrix_impact
ParameterTypeRequiredDescription
No parameters.
update_severity_matrix_impact Write

Update a severity matrix impact Official FireHydrant endpoint: PATCH /v1/severity_matrix/impacts/{impact_id} Update a severity matrix impact

Lua path
app.integrations.firehydrant.update_severity_matrix_impact
Full name
firehydrant.firehydrant_update_severity_matrix_impact
ParameterTypeRequiredDescription
No parameters.
delete_severity_matrix_impact Write

Delete a severity matrix impact Official FireHydrant endpoint: DELETE /v1/severity_matrix/impacts/{impact_id} Delete a specific impact

Lua path
app.integrations.firehydrant.delete_severity_matrix_impact
Full name
firehydrant.firehydrant_delete_severity_matrix_impact
ParameterTypeRequiredDescription
No parameters.
list_scheduled_maintenance_events Read

List scheduled maintenance events Official FireHydrant endpoint: GET /v1/scheduled_maintenances Lists all scheduled maintenance events

Lua path
app.integrations.firehydrant.list_scheduled_maintenance_events
Full name
firehydrant.firehydrant_list_scheduled_maintenances
ParameterTypeRequiredDescription
No parameters.
create_scheduled_maintenance_event Write

Create a scheduled maintenance event Official FireHydrant endpoint: POST /v1/scheduled_maintenances Create a new scheduled maintenance event

Lua path
app.integrations.firehydrant.create_scheduled_maintenance_event
Full name
firehydrant.firehydrant_create_scheduled_maintenance
ParameterTypeRequiredDescription
No parameters.
get_scheduled_maintenance_event Read

Get a scheduled maintenance event Official FireHydrant endpoint: GET /v1/scheduled_maintenances/{scheduled_maintenance_id} Fetch the details of a scheduled maintenance event.

Lua path
app.integrations.firehydrant.get_scheduled_maintenance_event
Full name
firehydrant.firehydrant_get_scheduled_maintenance
ParameterTypeRequiredDescription
No parameters.
update_scheduled_maintenance_event Write

Update a scheduled maintenance event Official FireHydrant endpoint: PATCH /v1/scheduled_maintenances/{scheduled_maintenance_id} Change the conditions of a scheduled maintenance event, including updating any status page announcements of chan

Lua path
app.integrations.firehydrant.update_scheduled_maintenance_event
Full name
firehydrant.firehydrant_update_scheduled_maintenance
ParameterTypeRequiredDescription
No parameters.
delete_scheduled_maintenance_event Write

Delete a scheduled maintenance event Official FireHydrant endpoint: DELETE /v1/scheduled_maintenances/{scheduled_maintenance_id} Delete a scheduled maintenance event, preventing it from taking place.

Lua path
app.integrations.firehydrant.delete_scheduled_maintenance_event
Full name
firehydrant.firehydrant_delete_scheduled_maintenance
ParameterTypeRequiredDescription
No parameters.
list_schedules Read

List schedules Official FireHydrant endpoint: GET /v1/schedules List all known schedules in FireHydrant as pulled from external sources

Lua path
app.integrations.firehydrant.list_schedules
Full name
firehydrant.firehydrant_list_schedules
ParameterTypeRequiredDescription
No parameters.
lists_functionality_service_and_environment_objects Read

Lists functionality, service and environment objects Official FireHydrant endpoint: GET /v1/infrastructures Lists functionality, service and environment objects

Lua path
app.integrations.firehydrant.lists_functionality_service_and_environment_objects
Full name
firehydrant.firehydrant_list_infrastructures
ParameterTypeRequiredDescription
No parameters.
unsubscribe_from_status_page_notifications Write

Unsubscribe from status page notifications Official FireHydrant endpoint: DELETE /v1/nunc/subscriptions/{unsubscribe_token} Unsubscribe from status page updates

Lua path
app.integrations.firehydrant.unsubscribe_from_status_page_notifications
Full name
firehydrant.firehydrant_delete_nunc_subscription
ParameterTypeRequiredDescription
No parameters.
create_status_page_subscription Write

Create a status page subscription Official FireHydrant endpoint: POST /v1/nunc/subscriptions Subscribe to status page updates

Lua path
app.integrations.firehydrant.create_status_page_subscription
Full name
firehydrant.firehydrant_create_nunc_subscription
ParameterTypeRequiredDescription
No parameters.
list_status_update_templates Read

List status update templates Official FireHydrant endpoint: GET /v1/status_update_templates List all status update templates for your organization

Lua path
app.integrations.firehydrant.list_status_update_templates
Full name
firehydrant.firehydrant_list_status_update_templates
ParameterTypeRequiredDescription
No parameters.
create_status_update_template Write

Create a status update template Official FireHydrant endpoint: POST /v1/status_update_templates Create a status update template for your organization

Lua path
app.integrations.firehydrant.create_status_update_template
Full name
firehydrant.firehydrant_create_status_update_template
ParameterTypeRequiredDescription
No parameters.
get_status_update_template Read

Get a status update template Official FireHydrant endpoint: GET /v1/status_update_templates/{status_update_template_id} Get a single status update template by ID

Lua path
app.integrations.firehydrant.get_status_update_template
Full name
firehydrant.firehydrant_get_status_update_template
ParameterTypeRequiredDescription
No parameters.
update_status_update_template Write

Update a status update template Official FireHydrant endpoint: PATCH /v1/status_update_templates/{status_update_template_id} Update a single status update template

Lua path
app.integrations.firehydrant.update_status_update_template
Full name
firehydrant.firehydrant_update_status_update_template
ParameterTypeRequiredDescription
No parameters.
delete_status_update_template Write

Delete a status update template Official FireHydrant endpoint: DELETE /v1/status_update_templates/{status_update_template_id} Delete a single status update template

Lua path
app.integrations.firehydrant.delete_status_update_template
Full name
firehydrant.firehydrant_delete_status_update_template
ParameterTypeRequiredDescription
No parameters.
update_custom_field_definition Write

Update a custom field definition Official FireHydrant endpoint: PATCH /v1/custom_fields/definitions/{field_id} Update a single custom field definition

Lua path
app.integrations.firehydrant.update_custom_field_definition
Full name
firehydrant.firehydrant_update_custom_field_definition
ParameterTypeRequiredDescription
No parameters.
delete_custom_field_definition Write

Delete a custom field definition Official FireHydrant endpoint: DELETE /v1/custom_fields/definitions/{field_id} Delete a custom field definition

Lua path
app.integrations.firehydrant.delete_custom_field_definition
Full name
firehydrant.firehydrant_delete_custom_field_definition
ParameterTypeRequiredDescription
No parameters.
list_custom_field_definitions Read

List custom field definitions Official FireHydrant endpoint: GET /v1/custom_fields/definitions List all custom field definitions

Lua path
app.integrations.firehydrant.list_custom_field_definitions
Full name
firehydrant.firehydrant_list_custom_field_definitions
ParameterTypeRequiredDescription
No parameters.
create_custom_field_definition Write

Create a custom field definition Official FireHydrant endpoint: POST /v1/custom_fields/definitions Create a new custom field definition

Lua path
app.integrations.firehydrant.create_custom_field_definition
Full name
firehydrant.firehydrant_create_custom_field_definition
ParameterTypeRequiredDescription
No parameters.
get_available_values_custom_field Read

Get available values for a custom field Official FireHydrant endpoint: GET /v1/custom_fields/definitions/{field_id}/select_options Get the permissible values for the a currently active custom select or multi-select field.

Lua path
app.integrations.firehydrant.get_available_values_custom_field
Full name
firehydrant.firehydrant_list_custom_field_select_options
ParameterTypeRequiredDescription
No parameters.
list_retrospective_reports Read

List retrospective reports Official FireHydrant endpoint: GET /v1/post_mortems/reports List all reports

Lua path
app.integrations.firehydrant.list_retrospective_reports
Full name
firehydrant.firehydrant_list_post_mortem_reports
ParameterTypeRequiredDescription
No parameters.
create_retrospective_report Write

Create a retrospective report Official FireHydrant endpoint: POST /v1/post_mortems/reports Create a report

Lua path
app.integrations.firehydrant.create_retrospective_report
Full name
firehydrant.firehydrant_create_post_mortem_report
ParameterTypeRequiredDescription
No parameters.
get_retrospective_report Read

Get a retrospective report Official FireHydrant endpoint: GET /v1/post_mortems/reports/{report_id} Get a report

Lua path
app.integrations.firehydrant.get_retrospective_report
Full name
firehydrant.firehydrant_get_post_mortem_report
ParameterTypeRequiredDescription
No parameters.
update_retrospective_report Write

Update a retrospective report Official FireHydrant endpoint: PATCH /v1/post_mortems/reports/{report_id} Update a report

Lua path
app.integrations.firehydrant.update_retrospective_report
Full name
firehydrant.firehydrant_update_post_mortem_report
ParameterTypeRequiredDescription
No parameters.
list_contributing_factors_retrospective_report Read

List contributing factors for a retrospective report Official FireHydrant endpoint: GET /v1/post_mortems/reports/{report_id}/reasons List all contributing factors to an incident

Lua path
app.integrations.firehydrant.list_contributing_factors_retrospective_report
Full name
firehydrant.firehydrant_list_post_mortem_reasons
ParameterTypeRequiredDescription
No parameters.
create_contributing_factor_retrospective_report Write

Create a contributing factor for a retrospective report Official FireHydrant endpoint: POST /v1/post_mortems/reports/{report_id}/reasons Add a new contributing factor to an incident

Lua path
app.integrations.firehydrant.create_contributing_factor_retrospective_report
Full name
firehydrant.firehydrant_create_post_mortem_reason
ParameterTypeRequiredDescription
No parameters.
update_contributing_factor_retrospective_report Write

Update a contributing factor in a retrospective report Official FireHydrant endpoint: PATCH /v1/post_mortems/reports/{report_id}/reasons/{reason_id} Update a contributing factor

Lua path
app.integrations.firehydrant.update_contributing_factor_retrospective_report
Full name
firehydrant.firehydrant_update_post_mortem_reason
ParameterTypeRequiredDescription
No parameters.
delete_contributing_factor_from_retrospective_report Write

Delete a contributing factor from a retrospective report Official FireHydrant endpoint: DELETE /v1/post_mortems/reports/{report_id}/reasons/{reason_id} Delete a contributing factor

Lua path
app.integrations.firehydrant.delete_contributing_factor_from_retrospective_report
Full name
firehydrant.firehydrant_delete_post_mortem_reason
ParameterTypeRequiredDescription
No parameters.
reorder_contributing_factor_retrospective_report Write

Reorder a contributing factor for a retrospective report Official FireHydrant endpoint: PUT /v1/post_mortems/reports/{report_id}/reasons/order Update the order of contributing factors in a retrospective report

Lua path
app.integrations.firehydrant.reorder_contributing_factor_retrospective_report
Full name
firehydrant.firehydrant_reorder_post_mortem_reasons
ParameterTypeRequiredDescription
No parameters.
publish_retrospective_report Write

Publish a retrospective report Official FireHydrant endpoint: POST /v1/post_mortems/reports/{report_id}/publish Marks an incident retrospective as published and emails all of the participants in the report the summary

Lua path
app.integrations.firehydrant.publish_retrospective_report
Full name
firehydrant.firehydrant_publish_post_mortem_report
ParameterTypeRequiredDescription
No parameters.
update_retrospective_field Write

Update a retrospective field Official FireHydrant endpoint: PATCH /v1/post_mortems/reports/{report_id}/fields/{field_id} Update a field value on a post mortem report

Lua path
app.integrations.firehydrant.update_retrospective_field
Full name
firehydrant.firehydrant_update_post_mortem_field
ParameterTypeRequiredDescription
No parameters.
list_retrospective_questions Read

List retrospective questions Official FireHydrant endpoint: GET /v1/post_mortems/questions List the questions configured to be provided and filled out on each retrospective report.

Lua path
app.integrations.firehydrant.list_retrospective_questions
Full name
firehydrant.firehydrant_list_post_mortem_questions
ParameterTypeRequiredDescription
No parameters.
update_retrospective_questions Write

Update retrospective questions Official FireHydrant endpoint: PUT /v1/post_mortems/questions Update the questions configured to be provided and filled out on future retrospective reports.

Lua path
app.integrations.firehydrant.update_retrospective_questions
Full name
firehydrant.firehydrant_update_post_mortem_questions
ParameterTypeRequiredDescription
No parameters.
get_retrospective_question Read

Get a retrospective question Official FireHydrant endpoint: GET /v1/post_mortems/questions/{question_id} Get an incident retrospective question configured to be provided and filled out on each retrospective report.

Lua path
app.integrations.firehydrant.get_retrospective_question
Full name
firehydrant.firehydrant_get_post_mortem_question
ParameterTypeRequiredDescription
No parameters.
list_retrospective_templates Read

List retrospective templates Official FireHydrant endpoint: GET /v1/retrospective_templates List all retrospective templates

Lua path
app.integrations.firehydrant.list_retrospective_templates
Full name
firehydrant.firehydrant_list_retrospective_templates
ParameterTypeRequiredDescription
No parameters.
create_retrospective_template Write

Create a retrospective template Official FireHydrant endpoint: POST /v1/retrospective_templates Create a new retrospective template

Lua path
app.integrations.firehydrant.create_retrospective_template
Full name
firehydrant.firehydrant_create_retrospective_template
ParameterTypeRequiredDescription
No parameters.
get_retrospective_template Read

Get a retrospective template Official FireHydrant endpoint: GET /v1/retrospective_templates/{retrospective_template_id} Retrieve a single retrospective template by ID

Lua path
app.integrations.firehydrant.get_retrospective_template
Full name
firehydrant.firehydrant_get_retrospective_template
ParameterTypeRequiredDescription
No parameters.
update_retrospective_template Write

Update a retrospective template Official FireHydrant endpoint: PATCH /v1/retrospective_templates/{retrospective_template_id} Update a single retrospective template

Lua path
app.integrations.firehydrant.update_retrospective_template
Full name
firehydrant.firehydrant_update_retrospective_template
ParameterTypeRequiredDescription
No parameters.
delete_retrospective_template Write

Delete a retrospective template Official FireHydrant endpoint: DELETE /v1/retrospective_templates/{retrospective_template_id} Delete a single retrospective template

Lua path
app.integrations.firehydrant.delete_retrospective_template
Full name
firehydrant.firehydrant_delete_retrospective_template
ParameterTypeRequiredDescription
No parameters.
list_alerts Read

List alerts Official FireHydrant endpoint: GET /v1/alerts Retrieve all alerts, including Signals alerts and third-party

Lua path
app.integrations.firehydrant.list_alerts
Full name
firehydrant.firehydrant_list_alerts
ParameterTypeRequiredDescription
No parameters.
get_alert Read

Get an alert Official FireHydrant endpoint: GET /v1/alerts/{alert_id} Retrieve a single alert

Lua path
app.integrations.firehydrant.get_alert
Full name
firehydrant.firehydrant_get_alert
ParameterTypeRequiredDescription
No parameters.
list_alert_processing_log_entries Read

List alert processing log entries Official FireHydrant endpoint: GET /v1/processing_log_entries Processing Log Entries for a specific alert

Lua path
app.integrations.firehydrant.list_alert_processing_log_entries
Full name
firehydrant.firehydrant_list_processing_log_entries
ParameterTypeRequiredDescription
No parameters.
page_user_team_call_schedule_or_escalation_policy Write

Page a user, team, on-call schedule, or escalation policy Official FireHydrant endpoint: POST /v1/page/signals Used for paging an on-call target within FireHydrant's signals product. This can be used for paging users, teams, on-call schedul

Lua path
app.integrations.firehydrant.page_user_team_call_schedule_or_escalation_policy
Full name
firehydrant.firehydrant_create_signals_page
ParameterTypeRequiredDescription
No parameters.
list_tickets Read

List tickets Official FireHydrant endpoint: GET /v1/ticketing/tickets List all of the tickets that have been added to the organiation

Lua path
app.integrations.firehydrant.list_tickets
Full name
firehydrant.firehydrant_list_tickets
ParameterTypeRequiredDescription
No parameters.
create_ticket Write

Create a ticket Official FireHydrant endpoint: POST /v1/ticketing/tickets Creates a ticket for a project

Lua path
app.integrations.firehydrant.create_ticket
Full name
firehydrant.firehydrant_create_ticket
ParameterTypeRequiredDescription
No parameters.
get_ticket Read

Get a ticket Official FireHydrant endpoint: GET /v1/ticketing/tickets/{ticket_id} Retrieves a single ticket by ID

Lua path
app.integrations.firehydrant.get_ticket
Full name
firehydrant.firehydrant_get_ticket
ParameterTypeRequiredDescription
No parameters.
update_ticket Write

Update a ticket Official FireHydrant endpoint: PATCH /v1/ticketing/tickets/{ticket_id} Update a ticket's attributes

Lua path
app.integrations.firehydrant.update_ticket
Full name
firehydrant.firehydrant_update_ticket
ParameterTypeRequiredDescription
No parameters.
archive_ticket Write

Archive a ticket Official FireHydrant endpoint: DELETE /v1/ticketing/tickets/{ticket_id} Archive a ticket

Lua path
app.integrations.firehydrant.archive_ticket
Full name
firehydrant.firehydrant_delete_ticket
ParameterTypeRequiredDescription
No parameters.
list_ticketing_projects Read

List ticketing projects Official FireHydrant endpoint: GET /v1/ticketing/projects List all ticketing projects available to the organization

Lua path
app.integrations.firehydrant.list_ticketing_projects
Full name
firehydrant.firehydrant_list_ticketing_projects
ParameterTypeRequiredDescription
No parameters.
get_ticketing_project Read

Get a ticketing project Official FireHydrant endpoint: GET /v1/ticketing/projects/{ticketing_project_id} Retrieve a single ticketing project by ID

Lua path
app.integrations.firehydrant.get_ticketing_project
Full name
firehydrant.firehydrant_get_ticketing_project
ParameterTypeRequiredDescription
No parameters.
list_configuration_options_ticketing_project Read

List configuration options for a ticketing project Official FireHydrant endpoint: GET /v1/ticketing/projects/{ticketing_project_id}/configuration_options List all configuration options for a ticketing project

Lua path
app.integrations.firehydrant.list_configuration_options_ticketing_project
Full name
firehydrant.firehydrant_get_configuration_options
ParameterTypeRequiredDescription
No parameters.
list_field_configuration_options_ticketing_project Read

List a field's configuration options for a ticketing project Official FireHydrant endpoint: GET /v1/ticketing/projects/{ticketing_project_id}/configuration_options/options_for/{field_id} List a field's configuration options for a ticketing

Lua path
app.integrations.firehydrant.list_field_configuration_options_ticketing_project
Full name
firehydrant.firehydrant_get_options_for_field
ParameterTypeRequiredDescription
No parameters.
list_available_fields_ticket_field_mapping Read

List available fields for ticket field mapping Official FireHydrant endpoint: GET /v1/ticketing/projects/{ticketing_project_id}/field_maps/available_fields Returns metadata for the fields that are available for field mapping.

Lua path
app.integrations.firehydrant.list_available_fields_ticket_field_mapping
Full name
firehydrant.firehydrant_list_available_ticketing_field_maps
ParameterTypeRequiredDescription
No parameters.
create_field_mapping_ticketing_project Write

Create a field mapping for a ticketing project Official FireHydrant endpoint: POST /v1/ticketing/projects/{ticketing_project_id}/field_maps Creates field map for a ticketing project

Lua path
app.integrations.firehydrant.create_field_mapping_ticketing_project
Full name
firehydrant.firehydrant_create_ticketing_field_map
ParameterTypeRequiredDescription
No parameters.
get_field_map_ticketing_project Read

Get a field map for a ticketing project Official FireHydrant endpoint: GET /v1/ticketing/projects/{ticketing_project_id}/field_maps/{map_id} Retrieve field map for a ticketing project

Lua path
app.integrations.firehydrant.get_field_map_ticketing_project
Full name
firehydrant.firehydrant_get_ticketing_field_map
ParameterTypeRequiredDescription
No parameters.
update_field_map_ticketing_project Write

Update a field map for a ticketing project Official FireHydrant endpoint: PATCH /v1/ticketing/projects/{ticketing_project_id}/field_maps/{map_id} Update field map for a ticketing project

Lua path
app.integrations.firehydrant.update_field_map_ticketing_project
Full name
firehydrant.firehydrant_update_ticketing_field_map
ParameterTypeRequiredDescription
No parameters.
archive_field_map_ticketing_project Write

Archive a field map for a ticketing project Official FireHydrant endpoint: DELETE /v1/ticketing/projects/{ticketing_project_id}/field_maps/{map_id} Archive field map for a ticketing project

Lua path
app.integrations.firehydrant.archive_field_map_ticketing_project
Full name
firehydrant.firehydrant_delete_ticketing_field_map
ParameterTypeRequiredDescription
No parameters.
list_available_fields_ticket_field_mapping Read

List available fields for ticket field mapping Official FireHydrant endpoint: GET /v1/ticketing/projects/{ticketing_project_id}/inbound_field_maps/available_fields Returns metadata for the fields that are available for inbound field mapping

Lua path
app.integrations.firehydrant.list_available_fields_ticket_field_mapping
Full name
firehydrant.firehydrant_list_available_inbound_field_maps
ParameterTypeRequiredDescription
No parameters.
list_inbound_field_maps_ticketing_project Read

List inbound field maps for a ticketing project Official FireHydrant endpoint: GET /v1/ticketing/projects/{ticketing_project_id}/inbound_field_maps List all inbound field maps for a ticketing project

Lua path
app.integrations.firehydrant.list_inbound_field_maps_ticketing_project
Full name
firehydrant.firehydrant_list_inbound_field_maps
ParameterTypeRequiredDescription
No parameters.
create_inbound_field_map_ticketing_project Write

Create inbound field map for a ticketing project Official FireHydrant endpoint: POST /v1/ticketing/projects/{ticketing_project_id}/inbound_field_maps Creates inbound field map for a ticketing project

Lua path
app.integrations.firehydrant.create_inbound_field_map_ticketing_project
Full name
firehydrant.firehydrant_create_inbound_field_map
ParameterTypeRequiredDescription
No parameters.
get_inbound_field_map_ticketing_project Read

Get inbound field map for a ticketing project Official FireHydrant endpoint: GET /v1/ticketing/projects/{ticketing_project_id}/inbound_field_maps/{map_id} Retrieve inbound field map for a ticketing project

Lua path
app.integrations.firehydrant.get_inbound_field_map_ticketing_project
Full name
firehydrant.firehydrant_get_inbound_field_map
ParameterTypeRequiredDescription
No parameters.
update_inbound_field_map_ticketing_project Write

Update inbound field map for a ticketing project Official FireHydrant endpoint: PUT /v1/ticketing/projects/{ticketing_project_id}/inbound_field_maps/{map_id} Update inbound field map for a ticketing project

Lua path
app.integrations.firehydrant.update_inbound_field_map_ticketing_project
Full name
firehydrant.firehydrant_update_inbound_field_map
ParameterTypeRequiredDescription
No parameters.
archive_inbound_field_map_ticketing_project Write

Archive inbound field map for a ticketing project Official FireHydrant endpoint: DELETE /v1/ticketing/projects/{ticketing_project_id}/inbound_field_maps/{map_id} Archive inbound field map for a ticketing project

Lua path
app.integrations.firehydrant.archive_inbound_field_map_ticketing_project
Full name
firehydrant.firehydrant_delete_inbound_field_map
ParameterTypeRequiredDescription
No parameters.
create_ticketing_project_configuration Write

Create a ticketing project configuration Official FireHydrant endpoint: POST /v1/ticketing/projects/{ticketing_project_id}/provider_project_configurations Creates configuration for a ticketing project

Lua path
app.integrations.firehydrant.create_ticketing_project_configuration
Full name
firehydrant.firehydrant_create_ticketing_project_config
ParameterTypeRequiredDescription
No parameters.
get_configuration_ticketing_project Read

Get configuration for a ticketing project Official FireHydrant endpoint: GET /v1/ticketing/projects/{ticketing_project_id}/provider_project_configurations/{config_id} Retrieve configuration for a ticketing project

Lua path
app.integrations.firehydrant.get_configuration_ticketing_project
Full name
firehydrant.firehydrant_get_ticketing_project_config
ParameterTypeRequiredDescription
No parameters.
update_configuration_ticketing_project Write

Update configuration for a ticketing project Official FireHydrant endpoint: PATCH /v1/ticketing/projects/{ticketing_project_id}/provider_project_configurations/{config_id} Update configuration for a ticketing project

Lua path
app.integrations.firehydrant.update_configuration_ticketing_project
Full name
firehydrant.firehydrant_update_ticketing_project_config
ParameterTypeRequiredDescription
No parameters.
archive_ticketing_project_configuration Write

Archive a ticketing project configuration Official FireHydrant endpoint: DELETE /v1/ticketing/projects/{ticketing_project_id}/provider_project_configurations/{config_id} Archive configuration for a ticketing project

Lua path
app.integrations.firehydrant.archive_ticketing_project_configuration
Full name
firehydrant.firehydrant_delete_ticketing_project_config
ParameterTypeRequiredDescription
No parameters.
list_ticketing_priorities Read

List ticketing priorities Official FireHydrant endpoint: GET /v1/ticketing/priorities List all ticketing priorities available to the organization

Lua path
app.integrations.firehydrant.list_ticketing_priorities
Full name
firehydrant.firehydrant_list_ticketing_priorities
ParameterTypeRequiredDescription
No parameters.
create_ticketing_priority Write

Create a ticketing priority Official FireHydrant endpoint: POST /v1/ticketing/priorities Create a single ticketing priority

Lua path
app.integrations.firehydrant.create_ticketing_priority
Full name
firehydrant.firehydrant_create_ticketing_priority
ParameterTypeRequiredDescription
No parameters.
get_ticketing_priority Read

Get a ticketing priority Official FireHydrant endpoint: GET /v1/ticketing/priorities/{id} Retrieve a single ticketing priority by ID

Lua path
app.integrations.firehydrant.get_ticketing_priority
Full name
firehydrant.firehydrant_get_ticketing_priority
ParameterTypeRequiredDescription
No parameters.
update_ticketing_priority Write

Update a ticketing priority Official FireHydrant endpoint: PATCH /v1/ticketing/priorities/{id} Update a single ticketing priority's attributes

Lua path
app.integrations.firehydrant.update_ticketing_priority
Full name
firehydrant.firehydrant_update_ticketing_priority
ParameterTypeRequiredDescription
No parameters.
delete_ticketing_priority Write

Delete a ticketing priority Official FireHydrant endpoint: DELETE /v1/ticketing/priorities/{id} Delete a single ticketing priority by ID

Lua path
app.integrations.firehydrant.delete_ticketing_priority
Full name
firehydrant.firehydrant_delete_ticketing_priority
ParameterTypeRequiredDescription
No parameters.
list_ticket_tags Read

List ticket tags Official FireHydrant endpoint: GET /v1/ticketing/ticket_tags List all of the ticket tags in the organization

Lua path
app.integrations.firehydrant.list_ticket_tags
Full name
firehydrant.firehydrant_list_ticket_tags
ParameterTypeRequiredDescription
No parameters.
get_ticketing_form_configuration Read

Get the ticketing form configuration Official FireHydrant endpoint: GET /v1/ticketing/form_configurations Get the ticketing form configuration

Lua path
app.integrations.firehydrant.get_ticketing_form_configuration
Full name
firehydrant.firehydrant_get_ticketing_form_configuration
ParameterTypeRequiredDescription
No parameters.
list_ticketing_custom_fields Read

List ticketing custom fields Official FireHydrant endpoint: GET /v1/ticketing/custom_fields/definitions List all ticketing custom fields available to the organization

Lua path
app.integrations.firehydrant.list_ticketing_custom_fields
Full name
firehydrant.firehydrant_list_ticketing_custom_definitions
ParameterTypeRequiredDescription
No parameters.
create_ticketing_custom_field Write

Create a ticketing custom field Official FireHydrant endpoint: POST /v1/ticketing/custom_fields/definitions Creates a ticketing custom field for the organization

Lua path
app.integrations.firehydrant.create_ticketing_custom_field
Full name
firehydrant.firehydrant_create_ticketing_custom_definition
ParameterTypeRequiredDescription
No parameters.
update_ticketing_custom_field Write

Update a ticketing custom field Official FireHydrant endpoint: PATCH /v1/ticketing/custom_fields/definitions/{field_id} Update a ticketing custom field for the organization

Lua path
app.integrations.firehydrant.update_ticketing_custom_field
Full name
firehydrant.firehydrant_update_ticketing_custom_definition
ParameterTypeRequiredDescription
No parameters.
delete_ticketing_custom_field Write

Delete a ticketing custom field Official FireHydrant endpoint: DELETE /v1/ticketing/custom_fields/definitions/{field_id} Deletes a ticketing custom field for the organization

Lua path
app.integrations.firehydrant.delete_ticketing_custom_field
Full name
firehydrant.firehydrant_delete_ticketing_custom_definition
ParameterTypeRequiredDescription
No parameters.
list_task_lists Read

List task lists Official FireHydrant endpoint: GET /v1/task_lists Lists all task lists for your organization

Lua path
app.integrations.firehydrant.list_task_lists
Full name
firehydrant.firehydrant_list_task_lists
ParameterTypeRequiredDescription
No parameters.
create_task_list Write

Create a task list Official FireHydrant endpoint: POST /v1/task_lists Creates a new task list

Lua path
app.integrations.firehydrant.create_task_list
Full name
firehydrant.firehydrant_create_task_list
ParameterTypeRequiredDescription
No parameters.
get_task_list Read

Get a task list Official FireHydrant endpoint: GET /v1/task_lists/{task_list_id} Retrieves a single task list by ID

Lua path
app.integrations.firehydrant.get_task_list
Full name
firehydrant.firehydrant_get_task_list
ParameterTypeRequiredDescription
No parameters.
update_task_list Write

Update a task list Official FireHydrant endpoint: PATCH /v1/task_lists/{task_list_id} Updates a task list's attributes and task list items

Lua path
app.integrations.firehydrant.update_task_list
Full name
firehydrant.firehydrant_update_task_list
ParameterTypeRequiredDescription
No parameters.
delete_task_list Write

Delete a task list Official FireHydrant endpoint: DELETE /v1/task_lists/{task_list_id} Delete a task list

Lua path
app.integrations.firehydrant.delete_task_list
Full name
firehydrant.firehydrant_delete_task_list
ParameterTypeRequiredDescription
No parameters.
check_api_connectivity Read

Check API connectivity Official FireHydrant endpoint: GET /v1/noauth/ping Simple endpoint to verify your API connection is working

Lua path
app.integrations.firehydrant.check_api_connectivity
Full name
firehydrant.firehydrant_ping_noauth
ParameterTypeRequiredDescription
No parameters.
get_scim_group Read

Get a SCIM group Official FireHydrant endpoint: GET /v1/scim/v2/Groups/{id} SCIM endpoint that lists a Team (Colloquial for Group in the SCIM protocol)

Lua path
app.integrations.firehydrant.get_scim_group
Full name
firehydrant.firehydrant_get_scim_group
ParameterTypeRequiredDescription
No parameters.
update_scim_group_and_assign_members Write

Update a SCIM group and assign members Official FireHydrant endpoint: PUT /v1/scim/v2/Groups/{id} SCIM endpoint to update a Team (Colloquial for Group in the SCIM protocol). Any members defined in the payload will be assigned to the team wi

Lua path
app.integrations.firehydrant.update_scim_group_and_assign_members
Full name
firehydrant.firehydrant_update_scim_group
ParameterTypeRequiredDescription
No parameters.
partially_update_scim_group Write

Partially update a SCIM group Official FireHydrant endpoint: PATCH /v1/scim/v2/Groups/{id} SCIM endpoint to partially update a Team (Colloquial for Group in the SCIM protocol). Supports adding, removing, or replacing members using SCIM PATC

Lua path
app.integrations.firehydrant.partially_update_scim_group
Full name
firehydrant.firehydrant_patch_scim_group
ParameterTypeRequiredDescription
No parameters.
delete_scim_group Write

Delete a SCIM group Official FireHydrant endpoint: DELETE /v1/scim/v2/Groups/{id} SCIM endpoint to delete a Team (Colloquial for Group in the SCIM protocol).

Lua path
app.integrations.firehydrant.delete_scim_group
Full name
firehydrant.firehydrant_delete_scim_group
ParameterTypeRequiredDescription
No parameters.
list_scim_groups Read

List SCIM groups Official FireHydrant endpoint: GET /v1/scim/v2/Groups SCIM endpoint that lists all Teams (Colloquial for Group in the SCIM protocol)

Lua path
app.integrations.firehydrant.list_scim_groups
Full name
firehydrant.firehydrant_list_scim_groups
ParameterTypeRequiredDescription
No parameters.
create_scim_group_and_assign_members Write

Create a SCIM group and assign members Official FireHydrant endpoint: POST /v1/scim/v2/Groups SCIM endpoint to create a new Team (Colloquial for Group in the SCIM protocol). Any members defined in the payload will be assigned to the team wi

Lua path
app.integrations.firehydrant.create_scim_group_and_assign_members
Full name
firehydrant.firehydrant_create_scim_group
ParameterTypeRequiredDescription
No parameters.
get_scim_user Read

Get a SCIM user Official FireHydrant endpoint: GET /v1/scim/v2/Users/{id} SCIM endpoint that lists a User

Lua path
app.integrations.firehydrant.get_scim_user
Full name
firehydrant.firehydrant_get_scim_user
ParameterTypeRequiredDescription
No parameters.
update_user_from_scim_data Write

Update a User from SCIM data Official FireHydrant endpoint: PUT /v1/scim/v2/Users/{id} PUT SCIM endpoint to update a User. This endpoint is used to replace a resource's attributes.

Lua path
app.integrations.firehydrant.update_user_from_scim_data
Full name
firehydrant.firehydrant_update_scim_user
ParameterTypeRequiredDescription
No parameters.
update_user_from_scim_data Write

Update a User from SCIM data Official FireHydrant endpoint: PATCH /v1/scim/v2/Users/{id} PATCH SCIM endpoint to update a User. This endpoint is used to update a resource's attributes.

Lua path
app.integrations.firehydrant.update_user_from_scim_data
Full name
firehydrant.firehydrant_patch_scim_user
ParameterTypeRequiredDescription
No parameters.
delete_user_matching_scim_data Write

Delete a User matching SCIM data Official FireHydrant endpoint: DELETE /v1/scim/v2/Users/{id} SCIM endpoint to delete a User. This endpoint will deactivate a confirmed User record in our system.

Lua path
app.integrations.firehydrant.delete_user_matching_scim_data
Full name
firehydrant.firehydrant_delete_scim_user
ParameterTypeRequiredDescription
No parameters.
list_scim_users Read

List SCIM users Official FireHydrant endpoint: GET /v1/scim/v2/Users SCIM endpoint that lists users. This endpoint will display a list of Users currently in the system.

Lua path
app.integrations.firehydrant.list_scim_users
Full name
firehydrant.firehydrant_list_scim_users
ParameterTypeRequiredDescription
No parameters.
create_user_from_scim_data Write

Create a User from SCIM data Official FireHydrant endpoint: POST /v1/scim/v2/Users SCIM endpoint to create and provision a new User. This endpoint will provision the User, which allows them to accept their account throught their IDP or via

Lua path
app.integrations.firehydrant.create_user_from_scim_data
Full name
firehydrant.firehydrant_create_scim_user
ParameterTypeRequiredDescription
No parameters.
refresh_service_catalog Read

Refresh a service catalog Official FireHydrant endpoint: GET /v1/catalogs/{catalog_id}/refresh Schedules an async task to re-import catalog info and update catalog data accordingly.

Lua path
app.integrations.firehydrant.refresh_service_catalog
Full name
firehydrant.firehydrant_refresh_catalog
ParameterTypeRequiredDescription
No parameters.
ingest_service_catalog_data Write

Ingest service catalog data Official FireHydrant endpoint: POST /v1/catalogs/{catalog_id}/ingest Accepts catalog data in the configured format and asyncronously processes the data to incorporate changes into service catalog.

Lua path
app.integrations.firehydrant.ingest_service_catalog_data
Full name
firehydrant.firehydrant_ingest_catalog_data
ParameterTypeRequiredDescription
No parameters.
list_checklist_templates Read

List checklist templates Official FireHydrant endpoint: GET /v1/checklist_templates List all of the checklist templates that have been added to the organization

Lua path
app.integrations.firehydrant.list_checklist_templates
Full name
firehydrant.firehydrant_list_checklist_templates
ParameterTypeRequiredDescription
No parameters.
create_checklist_template Write

Create a checklist template Official FireHydrant endpoint: POST /v1/checklist_templates Creates a checklist template for the organization

Lua path
app.integrations.firehydrant.create_checklist_template
Full name
firehydrant.firehydrant_create_checklist_template
ParameterTypeRequiredDescription
No parameters.
get_checklist_template Read

Get a checklist template Official FireHydrant endpoint: GET /v1/checklist_templates/{id} Retrieves a single checklist template by ID

Lua path
app.integrations.firehydrant.get_checklist_template
Full name
firehydrant.firehydrant_get_checklist_template
ParameterTypeRequiredDescription
No parameters.
update_checklist_template Write

Update a checklist template Official FireHydrant endpoint: PATCH /v1/checklist_templates/{id} Update a checklist templates attributes

Lua path
app.integrations.firehydrant.update_checklist_template
Full name
firehydrant.firehydrant_update_checklist_template
ParameterTypeRequiredDescription
No parameters.
archive_checklist_template Write

Archive a checklist template Official FireHydrant endpoint: DELETE /v1/checklist_templates/{id} Archive a checklist template

Lua path
app.integrations.firehydrant.archive_checklist_template
Full name
firehydrant.firehydrant_delete_checklist_template
ParameterTypeRequiredDescription
No parameters.
get_initial_application_configuration Read

Get initial application configuration Official FireHydrant endpoint: GET /v1/bootstrap Get initial application configuration

Lua path
app.integrations.firehydrant.get_initial_application_configuration
Full name
firehydrant.firehydrant_get_bootstrap
ParameterTypeRequiredDescription
No parameters.
get_data_form_field_select Read

Get data for a form field on select Official FireHydrant endpoint: GET /v1/form_configurations/{slug}/append_data_on_select/{field_id}/{selected_value} Get data for a form field on select that should be appended to a form by using a templat

Lua path
app.integrations.firehydrant.get_data_form_field_select
Full name
firehydrant.firehydrant_append_form_data_on_selected_value_get
ParameterTypeRequiredDescription
No parameters.
get_form_configuration Read

Get a form configuration Official FireHydrant endpoint: GET /v1/form_configurations/{slug} Get a form configuration

Lua path
app.integrations.firehydrant.get_form_configuration
Full name
firehydrant.firehydrant_get_form_configuration
ParameterTypeRequiredDescription
No parameters.
delete_reaction_from_conversation_comment Write

Delete a reaction from a conversation comment Official FireHydrant endpoint: DELETE /v1/conversations/{conversation_id}/comments/{comment_id}/reactions/{reaction_id} Archive a reaction

Lua path
app.integrations.firehydrant.delete_reaction_from_conversation_comment
Full name
firehydrant.firehydrant_delete_comment_reaction
ParameterTypeRequiredDescription
No parameters.
list_reactions_conversation_comment Read

List reactions for a conversation comment Official FireHydrant endpoint: GET /v1/conversations/{conversation_id}/comments/{comment_id}/reactions List all of the reactions that have been added to a comment

Lua path
app.integrations.firehydrant.list_reactions_conversation_comment
Full name
firehydrant.firehydrant_list_comment_reactions
ParameterTypeRequiredDescription
No parameters.
create_reaction_conversation_comment Write

Create a reaction for a conversation comment Official FireHydrant endpoint: POST /v1/conversations/{conversation_id}/comments/{comment_id}/reactions Create a reaction on a comment

Lua path
app.integrations.firehydrant.create_reaction_conversation_comment
Full name
firehydrant.firehydrant_create_comment_reaction
ParameterTypeRequiredDescription
No parameters.
get_conversation_comment Read

Get a conversation comment Official FireHydrant endpoint: GET /v1/conversations/{conversation_id}/comments/{comment_id} Retrieves a single comment by ID

Lua path
app.integrations.firehydrant.get_conversation_comment
Full name
firehydrant.firehydrant_get_comment
ParameterTypeRequiredDescription
No parameters.
update_conversation_comment Write

Update a conversation comment Official FireHydrant endpoint: PATCH /v1/conversations/{conversation_id}/comments/{comment_id} Update a comment's attributes

Lua path
app.integrations.firehydrant.update_conversation_comment
Full name
firehydrant.firehydrant_update_comment
ParameterTypeRequiredDescription
No parameters.
archive_conversation_comment Write

Archive a conversation comment Official FireHydrant endpoint: DELETE /v1/conversations/{conversation_id}/comments/{comment_id} Archive a comment

Lua path
app.integrations.firehydrant.archive_conversation_comment
Full name
firehydrant.firehydrant_delete_comment
ParameterTypeRequiredDescription
No parameters.
list_comments_conversation Read

List comments for a conversation Official FireHydrant endpoint: GET /v1/conversations/{conversation_id}/comments List all of the comments that have been added to the organization

Lua path
app.integrations.firehydrant.list_comments_conversation
Full name
firehydrant.firehydrant_list_comments
ParameterTypeRequiredDescription
No parameters.
create_conversation_comment Write

Create a conversation comment Official FireHydrant endpoint: POST /v1/conversations/{conversation_id}/comments Creates a comment for a project

Lua path
app.integrations.firehydrant.create_conversation_comment
Full name
firehydrant.firehydrant_create_comment
ParameterTypeRequiredDescription
No parameters.
update_signal_alert Write

Update a Signal alert Official FireHydrant endpoint: PATCH /v1/signals/alerts/{id} Update a Signal alert

Lua path
app.integrations.firehydrant.update_signal_alert
Full name
firehydrant.firehydrant_update_signals_alert
ParameterTypeRequiredDescription
No parameters.
generate_timeseries_alert_metrics Read

Generate timeseries alert metrics Official FireHydrant endpoint: GET /v1/signals/analytics/timeseries Generate a timeseries-based report of metrics for Signals alerts

Lua path
app.integrations.firehydrant.generate_timeseries_alert_metrics
Full name
firehydrant.firehydrant_get_signals_timeseries_analytics
ParameterTypeRequiredDescription
No parameters.
generate_grouped_alert_metrics Read

Generate grouped alert metrics Official FireHydrant endpoint: GET /v1/signals/analytics/grouped_metrics Generate a report of grouped metrics for Signals alerts

Lua path
app.integrations.firehydrant.generate_grouped_alert_metrics
Full name
firehydrant.firehydrant_get_signals_grouped_metrics
ParameterTypeRequiredDescription
No parameters.
get_mttx_analytics_signals Read

Get MTTX analytics for signals Official FireHydrant endpoint: GET /v1/signals/analytics/mttx Get mean-time-to-acknowledged (MTTA) and mean-time-to-resolved (MTTR) metrics for Signals alerts

Lua path
app.integrations.firehydrant.get_mttx_analytics_signals
Full name
firehydrant.firehydrant_get_signals_mttx_analytics
ParameterTypeRequiredDescription
No parameters.
get_noise_analytics_signals Read

Get noise analytics for signals Official FireHydrant endpoint: GET /v1/signals/analytics/noise/metrics Get noise metrics for Signals alerts

Lua path
app.integrations.firehydrant.get_noise_analytics_signals
Full name
firehydrant.firehydrant_get_signals_noise_analytics
ParameterTypeRequiredDescription
No parameters.
export_call_hours_report Read

Export on-call hours report Official FireHydrant endpoint: GET /v1/signals/analytics/shifts/export Export on-call hours report for users/teams during a time period

Lua path
app.integrations.firehydrant.export_call_hours_report
Full name
firehydrant.firehydrant_export_signals_shift_analytics
ParameterTypeRequiredDescription
No parameters.
list_call_routes Read

List call routes Official FireHydrant endpoint: GET /v1/signals/call_routes List call routes for the organization

Lua path
app.integrations.firehydrant.list_call_routes
Full name
firehydrant.firehydrant_list_call_routes
ParameterTypeRequiredDescription
No parameters.
retrieve_call_route Read

Retrieve a call route Official FireHydrant endpoint: GET /v1/signals/call_routes/{id} Retrieve a call route by ID

Lua path
app.integrations.firehydrant.retrieve_call_route
Full name
firehydrant.firehydrant_get_call_route
ParameterTypeRequiredDescription
No parameters.
update_call_route Write

Update a call route Official FireHydrant endpoint: PATCH /v1/signals/call_routes/{id} Update a call route by ID

Lua path
app.integrations.firehydrant.update_call_route
Full name
firehydrant.firehydrant_update_call_route
ParameterTypeRequiredDescription
No parameters.
delete_call_route Write

Delete a call route Official FireHydrant endpoint: DELETE /v1/signals/call_routes/{id} Delete a call route by ID

Lua path
app.integrations.firehydrant.delete_call_route
Full name
firehydrant.firehydrant_delete_call_route
ParameterTypeRequiredDescription
No parameters.
list_event_sources_signals Read

List event sources for Signals Official FireHydrant endpoint: GET /v1/signals/event_sources List all Signals event sources for the authenticated user.

Lua path
app.integrations.firehydrant.list_event_sources_signals
Full name
firehydrant.firehydrant_list_signals_event_sources
ParameterTypeRequiredDescription
No parameters.
create_event_source_signals Write

Create an event source for Signals Official FireHydrant endpoint: PUT /v1/signals/event_sources Create a Signals event source for the authenticated user.

Lua path
app.integrations.firehydrant.create_event_source_signals
Full name
firehydrant.firehydrant_create_signals_event_source
ParameterTypeRequiredDescription
No parameters.
get_event_source_signals Read

Get an event source for Signals Official FireHydrant endpoint: GET /v1/signals/event_sources/{transposer_slug} Get a Signals event source by slug

Lua path
app.integrations.firehydrant.get_event_source_signals
Full name
firehydrant.firehydrant_get_signals_event_source
ParameterTypeRequiredDescription
No parameters.
delete_event_source_signals Write

Delete an event source for Signals Official FireHydrant endpoint: DELETE /v1/signals/event_sources/{transposer_slug} Delete a Signals event source by slug

Lua path
app.integrations.firehydrant.delete_event_source_signals
Full name
firehydrant.firehydrant_delete_signals_event_source
ParameterTypeRequiredDescription
No parameters.
get_hacker_mode_status Read

Get hacker mode status Official FireHydrant endpoint: GET /v1/signals/hacker_mode Get the status of the hacker mode for the current user

Lua path
app.integrations.firehydrant.get_hacker_mode_status
Full name
firehydrant.firehydrant_get_signals_hacker_mode
ParameterTypeRequiredDescription
No parameters.
list_alert_grouping_configurations Read

List alert grouping configurations. Official FireHydrant endpoint: GET /v1/signals/grouping List all Signals alert grouping rules for the organization.

Lua path
app.integrations.firehydrant.list_alert_grouping_configurations
Full name
firehydrant.firehydrant_list_signals_alert_grouping_configurations
ParameterTypeRequiredDescription
No parameters.
create_alert_grouping_configuration Write

Create an alert grouping configuration. Official FireHydrant endpoint: POST /v1/signals/grouping Create a Signals alert grouping rule for the organization.

Lua path
app.integrations.firehydrant.create_alert_grouping_configuration
Full name
firehydrant.firehydrant_create_signals_alert_grouping_configuration
ParameterTypeRequiredDescription
No parameters.
get_alert_grouping_configuration Read

Get an alert grouping configuration. Official FireHydrant endpoint: GET /v1/signals/grouping/{id} Get a Signals alert grouping rule by ID.

Lua path
app.integrations.firehydrant.get_alert_grouping_configuration
Full name
firehydrant.firehydrant_get_signals_alert_grouping_configuration
ParameterTypeRequiredDescription
No parameters.
update_alert_grouping_configuration Write

Update an alert grouping configuration. Official FireHydrant endpoint: PATCH /v1/signals/grouping/{id} Update a Signals alert grouping rule for the organization.

Lua path
app.integrations.firehydrant.update_alert_grouping_configuration
Full name
firehydrant.firehydrant_update_signals_alert_grouping_configuration
ParameterTypeRequiredDescription
No parameters.
delete_alert_grouping_configuration Write

Delete an alert grouping configuration. Official FireHydrant endpoint: DELETE /v1/signals/grouping/{id} Delete a Signals alert grouping rule by ID.

Lua path
app.integrations.firehydrant.delete_alert_grouping_configuration
Full name
firehydrant.firehydrant_delete_signals_alert_grouping_configuration
ParameterTypeRequiredDescription
No parameters.
list_email_targets_signals Read

List email targets for signals Official FireHydrant endpoint: GET /v1/signals/email_targets List all Signals email targets for a team.

Lua path
app.integrations.firehydrant.list_email_targets_signals
Full name
firehydrant.firehydrant_list_signals_email_targets
ParameterTypeRequiredDescription
No parameters.
create_email_target_signals Write

Create an email target for signals Official FireHydrant endpoint: POST /v1/signals/email_targets Create a Signals email target for a team.

Lua path
app.integrations.firehydrant.create_email_target_signals
Full name
firehydrant.firehydrant_create_signals_email_target
ParameterTypeRequiredDescription
No parameters.
get_signal_email_target Read

Get a signal email target Official FireHydrant endpoint: GET /v1/signals/email_targets/{id} Get a Signals email target by ID

Lua path
app.integrations.firehydrant.get_signal_email_target
Full name
firehydrant.firehydrant_get_signals_email_target
ParameterTypeRequiredDescription
No parameters.
update_email_target Write

Update an email target Official FireHydrant endpoint: PATCH /v1/signals/email_targets/{id} Update a Signals email target by ID

Lua path
app.integrations.firehydrant.update_email_target
Full name
firehydrant.firehydrant_update_signals_email_target
ParameterTypeRequiredDescription
No parameters.
delete_signal_email_target Write

Delete a signal email target Official FireHydrant endpoint: DELETE /v1/signals/email_targets/{id} Delete a Signals email target by ID

Lua path
app.integrations.firehydrant.delete_signal_email_target
Full name
firehydrant.firehydrant_delete_signals_email_target
ParameterTypeRequiredDescription
No parameters.
list_webhook_targets Read

List webhook targets Official FireHydrant endpoint: GET /v1/signals/webhook_targets List all Signals webhook targets.

Lua path
app.integrations.firehydrant.list_webhook_targets
Full name
firehydrant.firehydrant_list_signals_webhook_targets
ParameterTypeRequiredDescription
No parameters.
create_webhook_target Write

Create a webhook target Official FireHydrant endpoint: POST /v1/signals/webhook_targets Create a Signals webhook target.

Lua path
app.integrations.firehydrant.create_webhook_target
Full name
firehydrant.firehydrant_create_signals_webhook_target
ParameterTypeRequiredDescription
No parameters.
get_webhook_target Read

Get a webhook target Official FireHydrant endpoint: GET /v1/signals/webhook_targets/{id} Get a Signals webhook target by ID

Lua path
app.integrations.firehydrant.get_webhook_target
Full name
firehydrant.firehydrant_get_signals_webhook_target
ParameterTypeRequiredDescription
No parameters.
update_webhook_target Write

Update a webhook target Official FireHydrant endpoint: PATCH /v1/signals/webhook_targets/{id} Update a Signals webhook target by ID

Lua path
app.integrations.firehydrant.update_webhook_target
Full name
firehydrant.firehydrant_update_signals_webhook_target
ParameterTypeRequiredDescription
No parameters.
delete_webhook_target Write

Delete a webhook target Official FireHydrant endpoint: DELETE /v1/signals/webhook_targets/{id} Delete a Signals webhook target by ID

Lua path
app.integrations.firehydrant.delete_webhook_target
Full name
firehydrant.firehydrant_delete_signals_webhook_target
ParameterTypeRequiredDescription
No parameters.
list_heartbeat_endpoint_configurations Read

List heartbeat endpoint configurations Official FireHydrant endpoint: GET /v1/signals/heartbeat_endpoints Retrieve all heartbeat endpoint configurations for your organization

Lua path
app.integrations.firehydrant.list_heartbeat_endpoint_configurations
Full name
firehydrant.firehydrant_list_signals_heartbeat_endpoint_configurations
ParameterTypeRequiredDescription
No parameters.
create_heartbeat_endpoint_configuration Write

Create a heartbeat endpoint configuration Official FireHydrant endpoint: POST /v1/signals/heartbeat_endpoints Create a new heartbeat endpoint configuration for your organization

Lua path
app.integrations.firehydrant.create_heartbeat_endpoint_configuration
Full name
firehydrant.firehydrant_create_signals_heartbeat_endpoint_configuration
ParameterTypeRequiredDescription
No parameters.
get_heartbeat_endpoint_status Read

Get heartbeat endpoint status Official FireHydrant endpoint: GET /v1/signals/heartbeat_endpoints/statuses Check the current status of a heartbeat endpoint

Lua path
app.integrations.firehydrant.get_heartbeat_endpoint_status
Full name
firehydrant.firehydrant_get_signals_heartbeat_endpoint_status
ParameterTypeRequiredDescription
No parameters.
get_heartbeat_endpoint_url Read

Get heartbeat endpoint URL Official FireHydrant endpoint: GET /v1/signals/heartbeat_endpoints/addresses Retrieve the URL for a heartbeat endpoint

Lua path
app.integrations.firehydrant.get_heartbeat_endpoint_url
Full name
firehydrant.firehydrant_get_signals_heartbeat_endpoint_url
ParameterTypeRequiredDescription
No parameters.
get_heartbeat_endpoint_configuration Read

Get a heartbeat endpoint configuration Official FireHydrant endpoint: GET /v1/signals/heartbeat_endpoints/{id} Retrieve a single heartbeat endpoint configuration

Lua path
app.integrations.firehydrant.get_heartbeat_endpoint_configuration
Full name
firehydrant.firehydrant_get_signals_heartbeat_endpoint_configuration
ParameterTypeRequiredDescription
No parameters.
update_heartbeat_endpoint_configuration Write

Update a heartbeat endpoint configuration Official FireHydrant endpoint: PATCH /v1/signals/heartbeat_endpoints/{id} Update an existing heartbeat endpoint configuration

Lua path
app.integrations.firehydrant.update_heartbeat_endpoint_configuration
Full name
firehydrant.firehydrant_update_signals_heartbeat_endpoint_configuration
ParameterTypeRequiredDescription
No parameters.
delete_heartbeat_endpoint_configuration Write

Delete a heartbeat endpoint configuration Official FireHydrant endpoint: DELETE /v1/signals/heartbeat_endpoints/{id} Delete a heartbeat endpoint configuration

Lua path
app.integrations.firehydrant.delete_heartbeat_endpoint_configuration
Full name
firehydrant.firehydrant_delete_signals_heartbeat_endpoint_configuration
ParameterTypeRequiredDescription
No parameters.
list_notification_policies Read

List notification policies Official FireHydrant endpoint: GET /v1/signals/notification_policy_items List all Signals notification policies.

Lua path
app.integrations.firehydrant.list_notification_policies
Full name
firehydrant.firehydrant_list_notification_policy_settings
ParameterTypeRequiredDescription
No parameters.
create_notification_policy Write

Create a notification policy Official FireHydrant endpoint: POST /v1/signals/notification_policy_items Create a Signals notification policy.

Lua path
app.integrations.firehydrant.create_notification_policy
Full name
firehydrant.firehydrant_create_notification_policy
ParameterTypeRequiredDescription
No parameters.
get_notification_policy Read

Get a notification policy Official FireHydrant endpoint: GET /v1/signals/notification_policy_items/{id} Get a Signals notification policy by ID

Lua path
app.integrations.firehydrant.get_notification_policy
Full name
firehydrant.firehydrant_get_notification_policy
ParameterTypeRequiredDescription
No parameters.
update_notification_policy Write

Update a notification policy Official FireHydrant endpoint: PATCH /v1/signals/notification_policy_items/{id} Update a Signals notification policy by ID

Lua path
app.integrations.firehydrant.update_notification_policy
Full name
firehydrant.firehydrant_update_notification_policy
ParameterTypeRequiredDescription
No parameters.
delete_notification_policy Write

Delete a notification policy Official FireHydrant endpoint: DELETE /v1/signals/notification_policy_items/{id} Delete a Signals notification policy by ID

Lua path
app.integrations.firehydrant.delete_notification_policy
Full name
firehydrant.firehydrant_delete_notification_policy
ParameterTypeRequiredDescription
No parameters.
list_notification_settings_user Read

List notification settings for a user Official FireHydrant endpoint: GET /v1/signals/users/{user_id}/notification_settings List all Signals notification settings for a specific user. Requires an API key with PII access enabled.

Lua path
app.integrations.firehydrant.list_notification_settings_user
Full name
firehydrant.firehydrant_list_user_notification_settings_by_user_id
ParameterTypeRequiredDescription
No parameters.
list_signal_transposers Read

List signal transposers Official FireHydrant endpoint: GET /v1/signals/transposers List all transposers for your organization

Lua path
app.integrations.firehydrant.list_signal_transposers
Full name
firehydrant.firehydrant_list_signals_transposers
ParameterTypeRequiredDescription
No parameters.
get_signals_ingestion_url Read

Get the signals ingestion URL Official FireHydrant endpoint: GET /v1/signals/ingest_url Retrieve the url for ingesting signals for your organization

Lua path
app.integrations.firehydrant.get_signals_ingestion_url
Full name
firehydrant.firehydrant_get_signals_ingest_url
ParameterTypeRequiredDescription
No parameters.
debug_signals_expressions Write

Debug Signals expressions Official FireHydrant endpoint: POST /v1/signals/debugger Debug Signals expressions

Lua path
app.integrations.firehydrant.debug_signals_expressions
Full name
firehydrant.firehydrant_debug_signals_expression
ParameterTypeRequiredDescription
No parameters.
list_who_call_organization Read

List who's on call for the organization Official FireHydrant endpoint: GET /v1/signals_on_call List all users who are currently on-call across the entire organization.

Lua path
app.integrations.firehydrant.list_who_call_organization
Full name
firehydrant.firehydrant_list_organization_on_call_schedules
ParameterTypeRequiredDescription
No parameters.
list_webhooks Read

List webhooks Official FireHydrant endpoint: GET /v1/webhooks Lists webhooks

Lua path
app.integrations.firehydrant.list_webhooks
Full name
firehydrant.firehydrant_list_webhooks
ParameterTypeRequiredDescription
No parameters.
create_webhook Write

Create a webhook Official FireHydrant endpoint: POST /v1/webhooks Create a new webhook

Lua path
app.integrations.firehydrant.create_webhook
Full name
firehydrant.firehydrant_create_webhook
ParameterTypeRequiredDescription
No parameters.
list_webhook_deliveries Read

List webhook deliveries Official FireHydrant endpoint: GET /v1/webhooks/{webhook_id}/deliveries Get webhook deliveries

Lua path
app.integrations.firehydrant.list_webhook_deliveries
Full name
firehydrant.firehydrant_list_webhook_deliveries
ParameterTypeRequiredDescription
No parameters.
get_webhook Read

Get a webhook Official FireHydrant endpoint: GET /v1/webhooks/{webhook_id} Retrieve a specific webhook

Lua path
app.integrations.firehydrant.get_webhook
Full name
firehydrant.firehydrant_get_webhook
ParameterTypeRequiredDescription
No parameters.
update_webhook Write

Update a webhook Official FireHydrant endpoint: PATCH /v1/webhooks/{webhook_id} Update a specific webhook

Lua path
app.integrations.firehydrant.update_webhook
Full name
firehydrant.firehydrant_update_webhook
ParameterTypeRequiredDescription
No parameters.
delete_webhook Write

Delete a webhook Official FireHydrant endpoint: DELETE /v1/webhooks/{webhook_id} Delete a specific webhook

Lua path
app.integrations.firehydrant.delete_webhook
Full name
firehydrant.firehydrant_delete_webhook
ParameterTypeRequiredDescription
No parameters.
get_current_user_vote_status_ai_generated_incident_summary Read

Get the current user's vote status for an AI-generated incident summary Official FireHydrant endpoint: GET /v1/ai/summarize_incident/{incident_id}/{generated_summary_id}/voted Get the current user's vote status for an AI-generated incident

Lua path
app.integrations.firehydrant.get_current_user_vote_status_ai_generated_incident_summary
Full name
firehydrant.firehydrant_get_ai_incident_summary_vote_status
ParameterTypeRequiredDescription
No parameters.
vote_ai_generated_incident_summary Write

Vote on an AI-generated incident summary Official FireHydrant endpoint: PUT /v1/ai/summarize_incident/{incident_id}/{generated_summary_id}/vote Vote on an AI-generated incident summary for the current user

Lua path
app.integrations.firehydrant.vote_ai_generated_incident_summary
Full name
firehydrant.firehydrant_vote_ai_incident_summary
ParameterTypeRequiredDescription
No parameters.
get_ai_preferences Read

Get AI preferences Official FireHydrant endpoint: GET /v1/ai/preferences Retrieves the current AI preferences

Lua path
app.integrations.firehydrant.get_ai_preferences
Full name
firehydrant.firehydrant_get_ai_preferences
ParameterTypeRequiredDescription
No parameters.
update_ai_preferences Write

Update AI preferences Official FireHydrant endpoint: PATCH /v1/ai/preferences Updates the AI preferences

Lua path
app.integrations.firehydrant.update_ai_preferences
Full name
firehydrant.firehydrant_update_ai_preferences
ParameterTypeRequiredDescription
No parameters.
list_audiences Read

List audiences Official FireHydrant endpoint: GET /v1/audiences List all audiences

Lua path
app.integrations.firehydrant.list_audiences
Full name
firehydrant.firehydrant_list_audiences
ParameterTypeRequiredDescription
No parameters.
create_audience Write

Create audience Official FireHydrant endpoint: POST /v1/audiences Create a new audience

Lua path
app.integrations.firehydrant.create_audience
Full name
firehydrant.firehydrant_create_audience
ParameterTypeRequiredDescription
No parameters.
get_audience Read

Get audience Official FireHydrant endpoint: GET /v1/audiences/{audience_id} Get audience details

Lua path
app.integrations.firehydrant.get_audience
Full name
firehydrant.firehydrant_get_audience
ParameterTypeRequiredDescription
No parameters.
update_audience Write

Update audience Official FireHydrant endpoint: PATCH /v1/audiences/{audience_id} Update an existing audience

Lua path
app.integrations.firehydrant.update_audience
Full name
firehydrant.firehydrant_update_audience
ParameterTypeRequiredDescription
No parameters.
archive_audience Write

Archive audience Official FireHydrant endpoint: DELETE /v1/audiences/{audience_id} Archive an audience

Lua path
app.integrations.firehydrant.archive_audience
Full name
firehydrant.firehydrant_archive_audience
ParameterTypeRequiredDescription
No parameters.
restore_audience Write

Restore audience Official FireHydrant endpoint: PATCH /v1/audiences/{audience_id}/restore Restore a previously archived audience

Lua path
app.integrations.firehydrant.restore_audience
Full name
firehydrant.firehydrant_restore_audience
ParameterTypeRequiredDescription
No parameters.
get_default_audience Read

Get default audience Official FireHydrant endpoint: GET /v1/audiences/member/{member_id}/default Get member's default audience

Lua path
app.integrations.firehydrant.get_default_audience
Full name
firehydrant.firehydrant_get_member_default_audience
ParameterTypeRequiredDescription
No parameters.
set_default_audience Write

Set default audience Official FireHydrant endpoint: PUT /v1/audiences/member/{member_id}/default Set member's default audience

Lua path
app.integrations.firehydrant.set_default_audience
Full name
firehydrant.firehydrant_set_member_default_audience
ParameterTypeRequiredDescription
No parameters.
get_latest_summary Read

Get latest summary Official FireHydrant endpoint: GET /v1/audiences/{audience_id}/summaries/{incident_id} Get the latest audience-specific summary for an incident

Lua path
app.integrations.firehydrant.get_latest_summary
Full name
firehydrant.firehydrant_get_audience_summary
ParameterTypeRequiredDescription
No parameters.
generate_summary_async Write

Generate summary (async) Official FireHydrant endpoint: POST /v1/audiences/{audience_id}/summaries/{incident_id} Initiates asynchronous generation of a new audience-specific summary for an incident. This is an async operation that can take

Lua path
app.integrations.firehydrant.generate_summary_async
Full name
firehydrant.firehydrant_generate_audience_summary
ParameterTypeRequiredDescription
No parameters.
list_audience_summaries Read

List audience summaries Official FireHydrant endpoint: GET /v1/audiences/summaries/{incident_id} List all audience summaries for an incident

Lua path
app.integrations.firehydrant.list_audience_summaries
Full name
firehydrant.firehydrant_list_audience_summaries
ParameterTypeRequiredDescription
No parameters.