Table of contents

...

• Webhooks

• Organization audit log

• Administration audit log

• Assets audit log

• Monitor fields

• Historic log sync

• Permissions

...

...

For all the actions it is possible to see the log starting from the installation of the plugin. However, for the issue- and asset-related actions, also historical data, starting from January 1st, 2022 will be also available in the app. With the first install, you will see the corresponding informational message:

...

After the first install, depending on the number of issues and Asset objects, retrieving historical data may take from minutes to hours.

...

Webhooks

You can use app webhooks to receive real-time updates for all the actions registered in the app. To do so, go to Settings (top right corner of the app) and click “Webhooks“ in the left menu.

...

To add a webhook endpoint URL, enter the URL in the “URL“ field and click Save:

...

The URL will be added to the list on the right:

...

After adding more than 10 endpoints, pagination will appear with 10 endpoints on every page.

From here you can add more endpoints, or

• Modify the existing one (you can edit URL)

• Mute the URL (a confirmation screen will be shown and if confirmed the API will be paused and will not receive the action data):

• Image Added

• Unmute the muted URL (a confirmation screen will be shown and if confirmed the API will activate and will again receive the action data):

• Image Added

• Delete the webhook:

• Image Added

JSON format

{
  "accountId": "ACTOR_ACCOUNT_ID",
  "accountName": "ACTOR_DISPLAY_NAME",
  "avatar": "ACTOR_AVATAR",
  "instanceName": "EVENT_INSTANCE_ADDRESS",
  "issueKey": "ISSUE_KEY",
  "requestTypeName": "REQUEST_TYPE_NAME",
  "issueTypeName": "ISSUE_TYPE_NAME",
  "actionType": "OCCURRED_ACTION",
  "target": "EVENT_TYPE",
  "projectKey": "PROJECT_KEY",
  "projectName": "PROJECT_NAME",
  "changedFrom": "OLD VALUE",
  "changedTo": "NEW VALUE",
  "createdAt": "EVENT_DATE",
  "objectId": "COMMON_OBJECT_ID",
  "summary": "ISSUE_SUMMARY"
}

Configuring Atlassian Guard (formerly Access) connection

If Atlassian Guard (formerly Access) is activated on your Cloud instance, you can retrieve three additional user actions:

• User reactivated

• User deactivated

• User last active (Date/time)

• User removed from site

• User invited to site

• User detail changed

To be able to view these actions, you need to configure a connection with Atlassian Guard. To do so, go to Settings (top right corner of the app) and Historic log sync:

...

From here you can see the the following information:

• App installation date

• Historical log date

  • The earliest date from when the logged actions will be synced and displayed in the app cannot be earlier than January 1st, 2022.

• “Sync historical logs” button to re-retrieve the historical data

  • After clicking the button you will see the confirmation popup and the status of the sync, while it is in progress.

  • Image Removed

• List of the actions that can be synced:

• Total: Number of the actions

The actions on the following components are not available in the historical data and only the actions done after the app installation will be visible:

• Global feature enable/disable

• Board

• Sprint

• Version

• Users

• Project category

• Comment update old value

• Issue deleted

• Actions from Jira administration audit log

• Jira organization audit log

• Assets audit log

• Issue view

Permissions

You can define user roles for the Jira users who can access the plugin. There are two roles available in the app:

• Administrator: can access all the logs in the app + access Settings and configure the app.

• Manager: can access all the logs in the app, but cannot access Settings and configure the app (the Settings are invisible for Manager).

To define roles for certain usersclick “Organization audit log“ in the left menu.

...

Enter two values in the corresponding fields:

• Organization ID

• API Key

To create/view both values, follow the instructions and click Connect. If the values are correct, you will see the success message, otherwise, a status/error notification will be displayed:

...

Configuring Jira Administration Audit Log connection

Connection with the Jira Administration Audit log is required for logging the following Actions:

1. Issue resolved

2. Status changed

3. Project role created

4. Project role updated

5. Project role deleted

6. Project category changed

7. Permission scheme created

8. Permission scheme copied

9. Permission scheme deleted

10. Permission scheme updated

11. Permission added

12. Permission deleted

13. Global permission added

14. Global permission deleted

15. Customer permissions changed

16. Agent Portal Announcement Update Permission

17. Permission scheme added to project

18. Project roles changed

19. JIRA Service Desk configuration

20. Login-free portal settings changed

21. Public signup enabled

22. Public signup disabled

23. Requirement for email verification for signup changed

24. Help center permissions changed

25. Help center updated

26. Issue view

To connect the app to the Jira Administration Log, go to Settings (top right corner of the app) and click “Permissions“ “Administration audit log“ in the left menu:

...

To add a user to the app, search and select the user or group from the dropdown menu, you can search the user by name, email, or group and select the user from the list:

...

Define the role of the user and click Save:

...

After adding, the user will be added to the list:

...

For the users in the list, you can change the Role from the list itself:

...

To remove the user from the Permissions, click Remove button and Delete button on the confirmation popup:

...

You can search users in the list by name or filter the list by role.

When a user, who does not have the right to use the app, tries to access the logs, the corresponding message will be displayed:

...

Enter an email of the user with valid Jira administrator permission and an API Token for the same user and click connect. Initially, the status of the connection will be Pending:

...

Click “Refresh status“ to update the status of the connection. If the connection is successful, you will see the corresponding status (refreshing status may take several seconds, click again if the status is not updated):

...

If the connection is successful, you will see the corresponding status and the error message:

...

You can delete the connection by clicking the “Delete connection” button while editing the connection and clicking the “Delete” button in the confirmation popup:

...

Configuring Assets Connection

...

• Workspace ID

  • Fill in the ID of the Assets (Insight) workspace you want to configure backup for. The Workspace ID can be found on the following link: https://[yourcloud].atlassian.net/rest/servicedeskapi/insight/workspace. The Jira Service Management REST API uses the workspace Id to identify your individual instance of Assets (Insight), it is an alphanumeric string at the end of the text shown on the opened link with the following sample appearance: 3b3b70g5-66f8-3c01-a2d7-e5bbf2584dc3:

  • {"size":1,"start":0,"limit":50,"isLastPage":true,"_links":{"self":"https://[yourcloud].atlassian.net/rest/servicedeskapi/assets/workspace","base":"https://[yourcloud].atlassian.net","context":""},"values":[{"workspaceId":"3b3b70g5-66f8-3c01-a2d7-e5bbf2584dc3"}]}

...

After filling in the three fields, click “Connect“ button. After Sync starts, the Pending Connection status“ message will be displayed. If the connection is successful, you will see the corresponding message:

...

You can also disable the connection to Assets by clicking the Delete connection button while editing the connection:

...

Configuring

...

If Atlassian Guard (formerly Access) is activated on your Cloud instance, you can retrieve three additional user actions:

• User reactivated

• User deactivated

• User last active (Date/time)

• User removed from site

• User invited to site

• User detail changed

...

Fields Monitoring

Historical Actions in the Logs

For all the actions it is possible to see the log starting from the installation of the plugin. However, for the issue- and asset-related actions, also historical data, starting from January 1st, 2022 will be also available in the app. With the first install, you will see the corresponding informational message:

...

After the first install, depending on the number of issues and Asset objects, retrieving historical data may take from minutes to hours.

To see the status of the historical data sync, go to Settings (top right corner of the app) and click “Organization audit log“ in the left menu.

...

Enter two values in the corresponding fields:

• Organization ID

• API Key

To create/view both values, follow the instructions and click Connect. If the values are correct, you will see the success message, otherwise, a status/error notification will be displayed:

...

Configuring Jira Administration Audit Log connection

Connection with the Jira Administration Audit log is required for logging the following Actions:

1. Issue resolved

2. Status changed

3. Project role created

4. Project role updated

5. Project role deleted

6. Project category changed

7. Permission scheme created

8. Permission scheme copied

9. Permission scheme deleted

10. Permission scheme updated

11. Permission added

12. Permission deleted

13. Global permission added

14. Global permission deleted

15. Customer permissions changed

16. Agent Portal Announcement Update Permission

17. Permission scheme added to project

18. Project roles changed

19. JIRA Service Desk configuration

20. Login-free portal settings changed

21. Public signup enabled

22. Public signup disabled

23. Requirement for email verification for signup changed

24. Help center permissions changed

25. Help center updated

26. Issue view

To connect the app to the Jira Administration Log, go to Settings (top right corner of the app) and click “Administration audit log“ in the left menu:

...

Enter an email of the user with valid Jira administrator permission and an API Token for the same user and click connect. Initially, the status of the connection will be Pending:

...

Click “Refresh status“ to update the status of the connection. If the connection is successful, you will see the corresponding status (refreshing status may take several seconds, click again if the status is not updated):

...

If the connection is successful, you will see the corresponding status and the error message:

...

You can delete the connection by clicking the “Delete connection” button while editing the connection and clicking the “Delete” button in the confirmation popup:

...

Webhooks

You can use app webhooks to receive real-time updates for all the actions registered in the app. To do soHistoric log sync:

...

From here you can see the the following information:

• App installation date

• Historical log date

  • The earliest date from when the logged actions will be synced and displayed in the app cannot be earlier than January 1st, 2022.

• “Sync historical logs” button to re-retrieve the historical data

  • After clicking the button you will see the confirmation popup and the status of the sync, while it is in progress.

  • Image Added

• List of the actions that can be synced:

• Total: Number of the actions

The actions on the following components are not available in the historical data and only the actions done after the app installation will be visible:

• Global feature enable/disable

• Board

• Sprint

• Version

• Users

• Project category

• Comment update old value

• Issue deleted

• Actions from Jira administration audit log

• Jira organization audit log

• Assets audit log

• Issue view

Permissions

You can define user roles for the Jira users who can access the plugin. There are two roles available in the app:

• Administrator: can access all the logs in the app + access Settings and configure the app.

• Manager: can access all the logs in the app, but cannot access Settings and configure the app (the Settings are invisible for Manager).

To define roles for certain users, go to Settings (top right corner of the app) and click “Webhooks“ “Permissions“ in the left menu.:

...

To add a webhook endpoint URL, enter the URL in the “URL“ field and click Save:

...

The URL will be added to the list on the right:

...

After adding more than 10 endpoints, pagination will appear with 10 endpoints on every page.

From here you can add more endpoints, or

• Modify the existing one (you can edit URL)

• Mute the URL (a confirmation screen will be shown and if confirmed the API will be paused and will not receive the action data):

• Image Removed

• Unmute the muted URL (a confirmation screen will be shown and if confirmed the API will activate and will again receive the action data):

• Image Removed

• Delete the webhook:

• Image Removed

JSON format

{
  "accountId": "ACTOR_ACCOUNT_ID",
  "accountName": "ACTOR_DISPLAY_NAME",
  "avatar": "ACTOR_AVATAR",
  "instanceName": "EVENT_INSTANCE_ADDRESS",
  "issueKey": "ISSUE_KEY",
  "requestTypeName": "REQUEST_TYPE_NAME",
  "issueTypeName": "ISSUE_TYPE_NAME",
  "actionType": "OCCURRED_ACTION",
  "target": "EVENT_TYPE",
  "projectKey": "PROJECT_KEY",
  "projectName": "PROJECT_NAME",
  "changedFrom": "OLD VALUE",
  "changedTo": "NEW VALUE",
  "createdAt": "EVENT_DATE",
  "objectId": "COMMON_OBJECT_ID",
  "summary": "ISSUE_SUMMARY"
}

Configuring Monitor fields

user to the app, search and select the user or group from the dropdown menu, you can search the user by name, email, or group and select the user from the list:

...

Define the role of the user and click Save:

...

After adding, the user will be added to the list:

...

For the users in the list, you can change the Role from the list itself:

...

To remove the user from the Permissions, click Remove button and Delete button on the confirmation popup:

...

You can search users in the list by name or filter the list by role.

When a user, who does not have the right to use the app, tries to access the logs, the corresponding message will be displayed:

...