Skip to main content

Opsgenie

The Opsgenie task is used to send alerts to the alerting system Opsgenie.

Opsgenie utilizes metadata to populate alert details and notify the appropriate responders. The task parameters allow for customization of the alert, including the message, priority, and the users who can view and respond to the alert.

Task parameters​

Configure these parameters for the Opsgenie task.

ParameterDescriptionRequired/ Optional
inputParameters.aliasA custom identifier that will be generated in Opsgenie when alerts are triggered. Up to 512 characters long.Required.
inputParameters.descriptionDescription of the alert, limited to 15,000 characters in Opsgenie.Required.
inputParameters.visibleToUsers in Opsgenie who can view the alerts. Can be a string, number, boolean, object/array, or null.Required.
inputParameters.respondersUsers in Opsgenie to be notified of the alert. Can be a string, number, boolean, object/array, or null.Required.
inputParameters.detailsAdditional details for the alert. Can be a string, number, boolean, object/array, or null.Optional.
inputParameters.messageMessage to be displayed in Opsgenie, providing a quick overview of the alert.Optional.
inputParameters.actionsOpsgenie actions to be executed on the alert. Can be a string or object/array.Optional
inputParameters.priorityThe priority of the alert.Optional.
inputParameters.entityDomain the alert is related to, such as the server's name or application.Optional.
inputParameters.tokenAPI token for integrating with Opsgenie. Refer to the official Opsgenie documentation to get the API keys.
Tip: Save the token as a secret in the Conductor for enhanced security.		Required.
inputParameters.tagsTags to be added to the alert in Opsgenie. Can be a string or object/array.Optional.

Task configuration​

This is the task configuration for an Opsgenie task.

{
  "name": "ops_genie_task",
  "taskReferenceName": "ops_genie_task_ref",
  "inputParameters": {
    "alias": "${workflow.input.opsGenieAlias}",
    "description": "${query_processor_ref.output.result.workflowsUrl}",
    "visibleTo": "${workflow.input.opsGenieVisibleTo}",
    "message": "Failed Worklows detected",
    "responders": "${workflow.input.opsGenieResponders}",
    "details": {
      "key": "value"
    },
    "priority": "${workflow.input.opsGeniePriority}",
    "entity": "${workflow.input.opsGenieEntity}",
    "tags": "${workflow.input.opsGenieTags}",
    "actions": "${workflow.input.opsGenieActions}",
    "token": "${workflow.secrets.OPS_GENIE_TOKEN}"
  },
  "type": "OPS_GENIE"
}

Task output​

The task returns a response with headers containing alert details such as alert ID, status, message, created/updated time, and so on.

Adding an Opsgenie task in UI​

To add an Opsgenie task:

  1. In your workflow, select the (+) icon and add a Opsgenie.
  2. Enter the Alias and Description.
  3. Set the respective user IDs in visibleTo and responders fields.
  4. (Optional) In Details, add any additional details for the alert.
  5. Set the following Opsgenie parameters:
  • Message—Message to be displayed in Opsgenie.
  • Actions—Action to be carried out on receiving the alert.
  • Priority—Set the priority of the alert.
  • Entity—Add the domain to which the alert is related to.
  • Tags—The tags to be added to the alert.
  • Token—The API token for integrating with Opsgenie. Refer to the official Opsgenie documentation on how to get the API keys.

Adding Opsgenie task

Examples​

Here are some examples for using the Opsgenie task.

Alerting using Opsgenie for failure workflow