Table of contents
Table of Contents | ||
---|---|---|
|
...
If you access the app for the first time, you will be presented to with a brief onboarding session, displaying the main features of the app. You can dismiss the session at any step.
...
Info |
---|
If you have IP allowlisting enabled on your Cloud instance (this is possible Jira for Premium plans), please contact us for the IP to be added to the Cloud allowlist. Without this, some actions will not be logged. |
The app configuration setting can be accessed by clicking the “Setting“ in the top right corner of the app:
...
You can configure the following settings in the app:
Webhooks
Organization audit log
Administration audit log
Assets audit log
Monitor fields
Historic log sync
Permissions
...
Historical Actions in the Logs
...
To remove the user from the Permissions, click Remove button and Delete button on the confirmation popup:
...
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"}]}
Info |
---|
Workspace ID is a mandatory field and can only be the Workspace ID of the current Cloud instance. |
...
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:
...
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:
...
Info |
---|
After successful connectionsconnection, the related actions will be retrieved every 30 minutes. |
...
Issue resolved
Status changed
Project role created
Project role updated
Project role deleted
Project category changed
Permission scheme created
Permission scheme copied
Permission scheme deleted
Permission scheme updated
Permission added
Permission deleted
Global permission added
Global permission deleted
Customer permissions changed
Agent Portal Announcement Update Permission
Permission scheme added to project
Project roles changed
JIRA Service Desk configuration
Login-free portal settings changed
Public signup enabled
Public signup disabled
Requirement for email verification for signup changed
Help center permissions changed
Help center updated
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:
...
Info |
---|
If the email format is invalid, the “Save” button will be disabled. |
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:
...
Info |
---|
The actions from the Jira administration audit log are retrieved every 30 minutes. |
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 so, go to Settings (top right corner of the app) and click “Webhooks“ in the left menu.
...
Code Block | ||
---|---|---|
| ||
{ "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
...