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:

Make sure the added endpoint accepts POST requests from https://auditlog.twinit.ge domain!

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):
Unmute the muted URL (a confirmation screen will be shown and if confirmed the API will activate and will again receive the action data):
Delete the webhook:

Make sure the endpoint accepts POST requests from dev.twinit.ge domain!

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 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:

After a successful connection, the related actions will be retrieved every 30 minutes.

If the connection with the Organization Log is lost, an email alert will be sent to the email address indicated in the configuration of the Administration Audit Log or Assets Log connection.

Configuring Jira Administration Audit Log connection

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

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:

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:

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:

If the connection with the Organization Log is lost, an email alert will be sent to the email address indicated in the configuration of the Administration Audit Log or Assets Log connection.

Configuring Assets Connection

The app includes action logs made on Assets (formerly Insight), namely object created and object updated.

The delete actions of Asset objects cannot be logged. However, you can restore deleted objects with Insight Assets Backup & Migration plugin.

To enable displaying the asset-related actions, go to Settings (top right corner of the app) and click “Assets audit log“ in the left menu:

The configuration consists of several fields to be filled:

Email
- Fill in the email related to the Atlassian account (valid JSM agent) that will be used to access the data in the Assets.

Email is a mandatory field!

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"}]}

Workspace ID is a mandatory field and can only be the Workspace ID of the current Cloud instance.

API Token
- Atlassian API token secures account access to the API. You can create a token, through the following URL: Atlassian account - API Tokens. You can read more about Atlassian API Token on the documentation page: Manage API tokens for your Atlassian account | Atlassian Support.
- After creating an API Token, just copy and paste it into the corresponding “API Token“ field on the configuration page.

API Token is a mandatory field!

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, indicating also the last successful sync date/time:

If there is an error in the filled fields, you will see the corresponding error message:

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

After a successful connection, the Asset actions will be retrieved. Depending on the number of the objects, it may take from minute to hours.

The Asset actions are retrieved every 6 hours, therefore the latest actions, done in the last 6 hours may not be shown in the logs. If you would like to sync the Asset actions immediately, go to “Assets audit log“ in the settings and click “Sync assets log“ button - depending on the number of the objects, it may take from minute to hours.

If the connection with the Organization Log is lost, an email alert will be sent to the email address indicated in the configuration of the Administration Audit Log or Assets Log connection.

Configuring Fields Monitoring

From here you can manage the fields, modification of which you want to log and track. For the instructions about how to view the actions on the selected fields, please visit User Guide.

After installation of the app, the fields list will be empty, meaning no fields are monitored:

To add the fields in the list of the monitored field, search and select them in the Add fields dropdown field (you can select several fields simultaneously):

The dropdown includes the system and the custom fields. You can search the fields by the name or field ID. the fields already added to the monitoring, will not show up in the dropdown.

After the fields are selected, click the ”Save” button and the selected fields will appear in the list under “Manage Monitored fields“:

The list shows:

ID of the field
Name of the filled
Date when the field monitoring started
You can remove the field from the monitoring

After the field is added to monitoring, you can filter the actions by the selected fields and show them in the breakdown.

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 of the previous year to the sync year, will be also available in the app. For example, if the historical log sync is started on September 5th, 2024, the logs will be synced from January 1st, 2023. 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 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.
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, and can access and configure only Monitor Fields in the Settings.

All Jira Administrators and Administrator permission in the app, by default. If a non-administrator is added to the Manager role, access to the projects where the user is not added will be given through the app.

To define roles for certain users, go to Settings (top right corner of the app) and click “Permissions“ 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:

You can add several users/groups into the list. If the user or a group is already added to one of the roles, it will not show up in the search results.

Define the role of the user and click Save: