Send audit log activities to another tool using webhooks

Establish a real-time streaming solution to automatically send audit log data to designated URLs of your choice.

Audit log webhook is a customized HTTP callbacks that trigger in response to audit log activities. When an activity occurs, the source system sends an HTTP request to the URL registered for the webhook in JSON format.

It’s important to know that webhook can be hosted or provided by any third-party tool. You should make sure that it’s appropriate for this data to be shared with your third-party tool before adding a webhhook.

How webhook works

Here is an example of how a webhook works:

1. Identify and choose a third-party service or application that will process incoming webhook notifications (e.g., a logging tool or a custom API endpoint).

2. Retrieve the URL from the selected tool which will receive audit log data.

3. Navigate to webhook settings and register a new webhook by providing the URL obtained from the tool and an optional authorization header.

4. When an action occurs within the Atlassian organization it triggers an associated audit log event.

5. The newly generated log is sent to the registered URL. This transmission occurs asynchronously. Explore the structure and appearance of the payload

Add a webhook

Webhook URL を登録するには、次の手順を実行します。

1. 移動 [アトラシアンの管理] に移動します。組織が複数ある場合は、対象の組織を選択します。

2. [セキュリティ] > [監査ログ] の順に選択します。

3. [設定] を選択します。

4. [Webhook] タブを選択します。

5. Select Add webhook.

6. Enter a Name for the webhook.

7. Webhook URL (リアルタイムでアクティビティの更新情報を受け取りたい宛先) を入力します。

8. Optionally enter secure authorization credentials to authenticate access to a protected resource. Encode the username and password as Authorization: Basic <credentials>.

9. 追加 を選択します 。

You can edit or remove a webhook if you need to.

制限事項

Webhook has the following limitations:

• Retries: events will be retried up to three times before failing to send to the registered URL.

• Ordering: event delivery is not guaranteed to be in chronological order. For example, Event B may be delivered before Event A, even if Event A occurred first.

• De-duplication: events may be delivered more than once. Each event will have the same information and ID. You must implement their own de-duplication logic.

• Service Level Objectives (SLOs): there are no public SLOs. No guarantees are provided regarding uptime or the delivery time of audit log.

Edit a webhook

登録した Webhook の詳細を編集するには、次の手順を実行します。

1. 移動 [アトラシアンの管理] に移動します。組織が複数ある場合は、対象の組織を選択します。

2. [セキュリティ] > [監査ログ] の順に選択します。

3. [設定] を選択します。

4. Under the desired webhook select More actions menu (⋯) .

5. Select Edit from the dropdown.

6. Update the details and select Save.

Test a webhook

このテストでは、重複する更新の送信を防ぐために集約されたアクティビティを少し遅れて送信する、Webhook のアクティビティ管理機能を評価します。

1. 移動 [アトラシアンの管理] に移動します。組織が複数ある場合は、対象の組織を選択します。

2. [セキュリティ] > [監査ログ] の順に選択します。

3. Under the desired webhook select Actions select (…) and select Test from the dropdown.