Integrations

Integrate release notes with various third-party products and receive notifications.

Integrations

The integration feature in Jira Release Notes extends the notification capabilities by enabling the sending of release notes to popular platforms such as Slack, Microsoft Teams, or any custom endpoint through Webhooks. Additionally, it offers the ability to publish the content of selected templates as new pages in Confluence with each release notes send, providing a seamless way to share release information and updates across different collaboration platforms.

Slack

To receive notifications in your Slack chat, make sure to configure the following fields. Use the Send test message button to verify that your settings are properly set up and functioning correctly.

Fields

Webhook URL

Use Slack documentation of Incoming Webhooks in order to create one. Incoming Webhhok is unique URL to which the Release Notes plugin sends notification.

User name

This field specifies the username from which you receive notifications in Slack. By default, it is set to Release Notes bot.

Icon emoji

This field determines the emoji icon associated with the user who sends notifications in Slack. You can choose any emoji you prefer, such as :ghost: 👻, to personalize the notification icon.

Message

The Slack notification message allows you to customize the content that will be sent as a notification. You can leverage the power of variables to dynamically populate the message with relevant information. Here is a list of supported variables that you can use to tailor the notification message according to your needs.

  • @channel - Mention everyone in the channel
  • {{setupName}} - Setup name
  • {{releaseDate}} - Date of release notes are sent
  • {{sprint}} - Completed sprint name. Available when trigger is Close of sprint
  • {{version}} - Released version name. Available when trigger is Release of version

Microsoft Teams

To receive notifications in Microsoft Teams, you need to set up the Webhook URL and Message fields. Use the Send test message button to verify that your settings are properly set up and functioning correctly.

Fields

Webhook URL

Use Microsoft Teams documentation of Incoming Webhooks in order to create one. Incoming Webhhok is unique URL to which the Release Notes plugin sends notification.

Message

The Microsoft Teams notification message allows you to customize the content that will be sent as a notification. You can leverage the power of variables to dynamically populate the message with relevant information. Here is a list of supported variables that you can use to tailor the notification message according to your needs.

  • {{setupName}} - Setup name
  • {{releaseDate}} - Date of release notes are sent
  • {{sprint}} - Completed sprint name. Available when trigger is Close of sprint
  • {{version}} - Released version name. Available when trigger is Release of version

Confluence

With Confluence integration, you can effortlessly publish the content of the generated template as a page or blog post whenever a release note is sent. To enable this integration, you need to configure the following fields to ensure a smooth setup and publication process.

Fields

URL

Your Confluence domain URL. Example https://myproject.atlassian.net

User name

Email address you are using to login to Confluence

API Token

Use Atlassian Documentation in order to create API Token for your account.

Title

Title of the Confluence page or blog post. It supports the following variables

  • {{setupName}} - Setup name
  • {{releaseDate}} - Date of release notes are sent
  • {{sprint}} - Completed sprint name. Available when trigger is Close of sprint
  • {{version}} - Released version name. Available when trigger is Release of version

Type

Type of Confluence publication. Page or Blog post

Space key

The key of the Confluence Space where you want to publish release notes

Parent page id

Specify parent page id if you want to publish release notes as a child page

Custom Webhook

If you want to receive release notes in any third-party service, you can utilize a custom URL webhook. This allows you to integrate the Jira Release Notes plugin with your service.

Fields

Webhook URL

URL of your third-party service to receive notifications from the Release Notes plugin, for example https://myproject.com/blog/new-post. The plugin will send a POST request to this URL with a JSON payload containing the HTML content of the release note template.
This enables seamless integration and automated content creation in external systems based on the release notes received.

JSON payload

{ payload: 'HTML content of release note template is here' }