> ## Documentation Index
> Fetch the complete documentation index at: https://docs.authsignal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Authenticator events

> Choose which authenticator changes send events, and include custom data points in authenticator events.

## Changes made in the Portal or Server API

By default, authenticator events are sent only for changes the user makes, plus [`authenticator.expired`](https://docs.authsignal.com/advanced-usage/webhooks/authenticator-expired). You can opt in to also receive events for changes an admin makes in the Authsignal Portal or your backend makes through the Server API.

To opt in, select **All events** under **Events to send** in the **Webhooks** section of [tenant settings](https://portal.authsignal.com/organisations/tenants/settings). With the Management API, set `authenticatorEventsWebhookConfig.includeEventsInitiatedBy` when you [update the tenant](https://docs.authsignal.com/api-reference/management-api/update-tenant.md).

## Custom data points

Authenticator events can include values from your [custom data points](https://docs.authsignal.com/actions-rules/rules/custom-data-points.md) in `data.customVariables`, the same field that [`email.created`](https://docs.authsignal.com/advanced-usage/webhooks/email-created) uses.

To include them:

1. Register the data points you want to include as [custom data points](https://portal.authsignal.com/organisations/tenants/custom_data_points).
2. In [Tenant settings](https://portal.authsignal.com/organisations/tenants/settings), open **Webhooks**.
3. Under **Authenticator events webhook URL**, select **Include custom data points**.
4. Select the data points to include, then save.

Each key in `customVariables` is the data point's name, prefixed by its source:

* User data points are prefixed with `user_`, such as `user_accountId`.
* Action data points are prefixed with `action_`, such as `action_transactionAmount`.

Authsignal includes only the selected data points that have a value set on the user or the action. If none of them has a value, the event has no `customVariables` field.

Action data points come from the action's custom data, so an event carries them only if it happened during an action. Those events include `actionCode` and `idempotencyKey`. [`authenticator.expired`](https://docs.authsignal.com/advanced-usage/webhooks/authenticator-expired) never happens during an action, so it carries only user data points.

```json theme={null}
{
  "type": "authenticator.created",
  "data": {
    "userId": "11111111-1111-1111-1111-111111111111",
    "actionCode": "signIn",
    "idempotencyKey": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "customVariables": {
      "user_accountId": "acct_123",
      "action_transactionAmount": "100.00"
    }
  }
}
```

To set the data points with the Management API, send their IDs in `authenticatorEventsWebhookConfig.allowedCustomVariables` when you [update the tenant](https://docs.authsignal.com/api-reference/management-api/update-tenant.md). [List Custom Data Points](https://docs.authsignal.com/api-reference/management-api/list-custom-data-points.md) returns each data point's ID. To keep the stored list, omit `allowedCustomVariables`. To stop including custom data points, send an empty array.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.