Content Comparison

...

• View of the USU Link should look like the image below after this change. 

...

4.2.3 Configuration of Jira Plugin Interface

...

It is possible to create more interfaces than one. Click “+ Create an Interface” button and configure another one. Bare in mind it is necessary to create InterfaceKey manually for another Interface.

...

4.2.4 Configuration of Jira Plugin Interface (Forge App - Beta)

All the information mentioned above remains applicable to this version of the application. The primary changes in this section are related to the UI, which has been updated to align with the Forge framework.

Note: No default interfaceKey is created in this version. This encourages the creation of interfaceKeys with a more readable and structured format.

...

4.3 WebHooks

4.3.1 Application WebHooks (Dynamic Webhooks)

...

4.3.2 Application WebHooks (Forge App - Beta) - System webhooks

To support a broader range of webhooks, including advanced JQL capabilities, we leverage Jira System Webhooks. This approach ensures greater flexibility and seamless integration with the application.

4.3.2.1 Creating a Jira Webhook

• Access Jira System Webhooks
  Navigate to Jira System Webhook Settings and click the Create a Webhook button.

• Configure the Webhook

  • Events: Select the relevant events provided by our app to ensure accurate data synchronization:

    • Issue Created

    • Issue Updated

    • Comment Created

    • Comment Updated

    • Attachment Created

    • Attachment Deleted

  • Secrets: Leave the secret field empty. The data is already authorized through the app's permissions.

• Set the Webhook URL

  • Obtain the Webhook URL from the App Settings:

    • Go to the app interface within the settings.

    • Click the three-dot menu next to the desired interface.

    • Select Copy Interface Webhook URL.

  • The copied URL will be unique to the specific interface and may look something like this:

    https://a8830105-ba1d-4385-a16f-e7c08070e3a4.hello.atlassian.dev.net/x1/bWXLK5TQVvruTgeBnVyE49t5Lcs?issue_id=${issue.id}&issue_key=${issue.key}&interfaceKey=USM_DOC

• Purpose of the URL

  • This URL ensures that webhook events (e.g., issue updates, comments) are forwarded to the correct interface in the app.

  • The app identifies the interface via the unique interfaceKey in the URL and processes the webhook data accordingly.

Webhook Data Verification:
The app only trusts the event type and issue ID from the webhook payload. All other data is retrieved directly from Jira using the app’s permissions, ensuring accuracy and security.

Data Forwarding:
Based on the interface configuration, the app fetches Jira data and securely forwards it to the designated third-party interfaces. This ensures that only verified and authorized data is processed, regardless of who triggers the webhook.

By following these steps, you can integrate Jira System Webhooks with our application seamlessly.

...

4.4 Event Mapping

Event to Generic Interface Action mapping:

...

* interfaceyKey  - identifies the certain interface.

4.4.1 Event Mapping (Forge app - Beta)

Event mapping functionality in this app version remains consistent with previous versions. The main change is where the mapping settings are configured.

To update event mapping:

1. Navigate to App Settings:

   • Open the app settings and locate the desired interface where you want to adjust the event mapping.

2. Access Event Mapping Options:

   • Click on the three-dot menu next to the interface.

   • Select Event Mapping from the dropdown menu.

3. Update Event Mapping:

   • Make the necessary changes to the event mapping following the process described earlier in this documentation.

...

...

4.5 Firewalls

There is a possibility to use Whitelisting for incoming messages to USM (Connector -> USM). You can use these two static IP addresses:

• 99.80.183.117

• 99.81.135.32

4.5.1 Firewalls (Forge app - Beta)

Current IP Address Ranges for Outbound Connections: https://support.atlassian.com/organization-administration/docs/ip-addresses-and-domains-for-atlassian-cloud-products/#Outgoing-Connections

You can use these IP address ranges to allow Forge apps to make connections through firewalls or integrate with software that has a managed IP allowlist.

Important Note:

• The IP address range for outgoing connections is shared by all Forge apps. Allowing connections from this range permits connections from any Forge app.

4.6 Functions of Jira Plugin Connector

...