Workflow Failure Alert Webhooks for OpsGenie

[ChingizK]

I'm trying to set up a Workflow Job Webhook notification to send an alert to OpsGenie REST API on job failure. We've set up Teams & Email successfully.

We've created the Webhook 

and when I configure "On Failure" I can see it in the JSON/YAML view.

 However, OpsGenie expects the payload to be in a specific format and I also want to append additional info regarding the job with the payload. Where can I configure this?

The documentation HERE shows an example payloads that are sent, but that's not what OpsGenie is expecting.

Any clarification on this is highly appreciated!

[Kaniz_Fatma]

Hi @ChingizK, Configuring the payload for OpsGenie Webhook integration is essential to ensure that the data sent to OpsGenie meets your requirements.

Let’s walk through the steps:

1. Create a Webhook Integration in OpsGenie:

   • Go to Settings > Integrations.
   • Click on Add integration.
   • Search for and select Webhook.
   • Enter a name for the integration.
   • Optionally, assign it to a specific team.
   • Click Continue to save the integration.
   • Finally, turn on the integration to make it active¹.

2. Mapping Alert Actions:

   • OpsGenie allows you to post Webhook URLs for alert actions.
   • Use the Post to Webhook URL for OpsGenie alerts section to define mappings for alert actions.
   • For example, you can configure OpsGenie to post to the URL when an alert is created.
   • Different actions (such as alert creation, acknowledgment, etc.) can trigger the Webhook.
   • When configuring the mapping, you can specify tags or custom actions.
   • If an alert has one or more of the specified tags, the mapping works.
   • For custom actions, you can save multiple mappings based on the given tags and custom action names.
   • Note that the Description and Details fields are truncated to 1000 characters in the alert action da...¹.

3. Customizing the Payload:

   • Unfortunately, OpsGenie does not provide a direct feature to customize the Webhook payload.
   • However, you can work around this limitation by sending the payload to another endpoint first and mo...².
   • Consider using an intermediary service or script to transform the payload into the format OpsGenie expects.

4. Sample Webhook Data:

   • OpsGenie sends alert activity data (create, acknowledge, etc.) as well as a subset of alert fields (alert ID, username, alias, entity, user ID) in the HTTP request payload (JSON).
   • You can also define custom headers for the Webhook call.
   • To send the alert description and details, select the related checkboxes in the integration settings¹.

Remember to review OpsGenie’s official documentation for any updates or additional details specific to your use case. If you encounter any issues, consider reaching out to OpsGenie’s community or support for further assistance. Good luck with your Webhook configuration! 😊🚀¹³.

!OpsGenie Webhook Configuration Image source: OpsGenie Webhook Configuration Guide³

Let me know if you need further clarification or assistance!

[portoedu · Accepted solution]

Hi guys,

I found a workaround by creating an email integration in opsgenie and then creating a databricks notification destination with that email.

[ChingizK]

Yes, this was the workaround we ended up implementing as well. Just setting up an email on the OpsGenie side and then adding that email address as email notification under the configs of the job workflow