• Products
  • Get started
  • Documentation
  • Resources

Integrate with Webhook

The feature described in this article is currently rolling out to some Jira Service Management Cloud customers. It may not yet be visible or available on your site.

Webhook logo

A URL endpoint can be any platform, web server, and so on as long as the URL is accessible from the Web. Webhook data includes alert activity (create, acknowledge, etc) as well as a subset of the alert fields (alert ID, username, alias, entity, user ID) as part of the HTTP request payload (JSON). You can also define custom headers to add the Webhook call. Send the alert description and alert details by simply selecting the related checkboxes.

The Description and Details fields are truncated to 1000 characters in the alert action data sent by the Webhook integration.

Add a Webhook integration

  1. Go to your team’s operations page.

  2. On the left navigation panel, select Integrations and then Add integration.

  3. Run a search and select “Webhook”.

  4. On the next screen, enter a name for the integration.

  5. Optional: Select a team in Assignee team if you want a specific team to receive alerts from the integration.

  6. Select Continue.
    The integration is saved at this point.

  7. Select Edit on the integration configuration page.
    The Edit integration settings dialog opens.

    1. Select Authenticate with a Webhook account.

    2. Paste your webhook URL into Webhook URL.

    3. Configure additional HTTP headers for your webhook calls.

    4. Select Add alert description to payload and Add alert details to payload if needed.

    5. Select Save.

  8. Select Turn on integration.
    The rules you create for the integration will work only if you turn on the integration.

The options Add alert description to payload and Add alert details to payload are only available for Create and Custom alert actions.

Map alert actions

Jira Service Management allows you to post Webhook URL for alert actions. Use Post to Webhook URL for Jira Service Management alerts section to post alert actions to the given URL. For example, add post to the URL when the alert is created. To do this, define "If alert is created in Jira Service Management", "post to url" mapping.

  • "a tag is added to the alert" and "a custom action is executed on alert" actions differ from other actions. When either action is selected, an extra field appears to enter for which tags or for which custom action this mapping works.

  • Enter multiple tags by separating the tags with a comma. If multiple tags are entered, the mapping works if the alert has one or more of the specified tags. Leave the tags field empty for the mapping to work for any tag.

  • If a Jira Service Management action is associated with multiple "post to URL" actions in Webhook integration, an error occurs except for the "a tag is added to the alert" and "a custom action is executed on alert" actions. You can save multiple mappings for only these actions, because they differ by the given tags and the given custom action names.

For sample Webhook data for different actions, see Jira Edge Connector alert action data.

 

Additional Help