Audit Log Webhook

Send Apono audit log notifications to your internal systems with event-triggered HTTP messages

By creating a webhook for audit log notifications, you can gather all notifications into a single platform.

---

Prerequisite

Item	Description
Apono Premium	Apono plan providing the most features and dedicated account support

---

Configure a webhook

Follow these steps to configure a webhook:

1. On the Webhooks page, click Add Webhook. The Add Webhook page appears.

2. Click Audit Webhook.

3. Enter a unique, alphanumeric, user-friendly Audit Webhook Name for identifying this webhook.

4. Click the Status toggle to Active.

5. From the Type dropdown menu, select HTTP Webhook.

6. From the Method dropdown menu, select a REST method.

7. In the URL field, enter the URL of the target system that will receive the webhook.

The webhook URL must adhere to the following requirements:

• Uses the HTTPS protocol

• Does not specify any custom ports

1. In the Body Template field, construct a JSON body for the webhook payload. The following is an example webhook payload.

{
    "event_type": "{{event_type}}",
    "event_time": "{{event_time}}",
    "data": {
        "timestamp": "{{data.timestamp}}",
        "action": "{{data.action}}",
        "actor_id": "{{data.actor_id}}",
        "actor_name": "{{data.actor_name}}",
        "actor_type": "{{data.actor_type}}",
        "source": "{{data.source}}",
        "target_id": "{{data.target_id}}",
        "target_type": "{{data.target_type}}",
        "target_name": "{{data.target_name}}",
        "metadata": "{{data.metadata}}",
        "current_target_object": "{{data.current_target_object}}",
        "previous_target_object": "{{data.previous_target_object}}"
    }
}

Click View audit event's payload schema to reveal the base payload schema and available data fields. You can also refer to the Audit Log Webhook Payload Schema Reference to read the descriptions of each data field.

1. Choose the relevant authentication method and enter the information required by the target system.

None

From the Authentication Type dropdown menu, select None.

OAuth

Follow these steps to add OAuth authentication:

1. From the Authentication Type dropdown menu, select OAuth. The OAuth settings appear.

2. Define the OAuth settings.

Setting	Description
Client ID	Unique identifier assigned by the authorization server
Client Secret	Secret key issued by the authorization server
Token Endpoint URL	URL where the authorization code or refresh token is exchanged for an access token
Scopes	(Optional) Set of permissions requested to access specific resources or APIs

Bearer Token

Follow this step to add Bearer Token authentication:

1. From the Authentication Type dropdown menu, select Bearer Token. The Bearer token settings appear.

2. Enter the Token.

By default the password is not shown. To display the token, click (eye icon).

Custom

Follow these steps to add custom authentication:

1. Under Headers, use the Key and Value fields to set the credential information.

2. If your tool or service has several values, enter each key-value pair in a separate row.

The following table uses Datadog as an example.

Key	Value
DD-API-KEY	<API KEY>
DD-APPLICATION-KEY	<KEY ID>

1. (Optional) In the Timeout in seconds field, enter the duration in seconds to wait before marking the request as failed.

2. (Optional) Define Response Validators to verify that the response from the webhook meets specified criteria:

   1. Click + Add. A row of settings appears.

   2. Starting with $.data., enter the Json Path of the JSON parameter.

   3. In the Expected Values field, enter a value and press the Enter key on your keyboard.

   4. Repeat step c to add several expected values.

   5. Repeat steps a-d to add multiple response validators.

3. Click Test to generate a test event to trigger your webhook. A Test successful or Test failed response status will appear at the bottom of the page. A successful test will send mock data to the target system.

For more information about the test, click View Invocation Data. A panel opens revealing the request, response, and other relevant details.

Should your test fail, view these tips to troubleshoot your webhook.

1. Click Save Webhook.

The new webhook appears in the Webhooks table. Active webhooks are preceded by a green dot. Inactive webhooks are preceded by a white dot.

Apono audit log notifications will be sent to the target system each time an audit log event occurs.