Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Lakewatch provides an API connector to ingest account audit logs from Zendesk Support. This page covers prerequisites, configuration instructions, the connector schema, and security observables.
Prerequisites
The connector requires:
- Serverless Lakeflow pipelines turned on in your workspace.
- Unity Catalog, with privileges to create or use a Unity Catalog connection. See Connection permissions.
- If your workspace's serverless network policy uses restricted access, the source's API domains must be on the policy's Allowed domains list. See Allow the source API domains in your network policy.
- A Zendesk Support account with permission to create OAuth clients. See Using OAuth authentication with your application.
- Access to the Zendesk Support Audit Logs API. See Audit Logs.
Known limitations
- Slowly changing dimension (SCD) type 2 is not supported.
- The connector supports only OAuth user-to-machine (U2M) authentication. OAuth machine-to-machine and basic authentication aren't supported.
- The first sync of the
audit_logstable starts at the datasource start time, which must be within the last 30 days. If you don't set a start time, ingestion starts when you create the datasource. Later syncs resume from the last ingestedtimevalue. See Choose how far back to ingest.
Configure Zendesk Support for ingestion
Create a confidential OAuth client in Zendesk Support. The Unique identifier is the client ID you enter in Azure Databricks.
Go to the admin center at
https://<subdomain>.zendesk.com/admin/home.Click Apps and integrations > APIs > OAuth clients.
Click Add OAuth client on the right side of the OAuth client list.
Complete the required fields to create a client:
Client name: Enter the name that appears in the list of apps with access to your Zendesk Support instance.
Unique identifier: Click the field to populate it with the client name automatically. You can change it if needed. This value is the Client ID in Azure Databricks.
Client kind: Select Confidential.
Redirect URLs: Enter
https://<your_workspace_domain>/login/oauth/lakehousefederation.html.Replace
<your_workspace_domain>with your workspace instance name, for exampleadb-1234567890123456.7.azuredatabricks.net.
Click Save. Copy the new, pre-populated Secret value that appears, which is the client secret you use when creating the connection. Zendesk shows it one time.
Click Save again.
Note the Zendesk subdomain (for example,
your-companyfromhttps://your-company.zendesk.com).
Tip
When you create a connection through the Lakewatch UI, enter the Subdomain, Client ID (the unique identifier), and Client secret from the previous steps. Click Sign in with Zendesk Support and authorize the application.
See Configure Zendesk Support for OAuth.
Next steps
After you configure Zendesk Support, create a datasource with the Zendesk connector in the Lakewatch UI. See API connectors for instructions.
Connector and Lakewatch schemas
The connector ingests the following source table from the default source schema:
| Source table | Zendesk data | Built-in Lakewatch parser |
|---|---|---|
audit_logs |
Account-level administrative actions and changes | zendesk_audit |
The connector writes each source table directly to the destination configured for its built-in parser. By default, the destination table is named <parser>_<datasource>, where <datasource> is the datasource name. For example, with the default datasource name zendesk, the table is zendesk_audit_zendesk. You can set a different destination during datasource creation. There is no separate raw staging table or later parsing step.
Lakewatch-managed columns
The connector adds the following columns to each output row:
lw_id: A non-null string that Lakewatch uses as the primary key. The connector derives a stable, time-sortable ID from the sourcecreated_atandidfields.time: A non-null UTC timestamp converted from the sourcecreated_atvalue. The connector usestimeas the cursor field for incremental ingestion.
The connector does not write the source id field to the destination table.
For Lakewatch datasources, the connector also adds lw_meta and lw_observables. lw_meta contains the datasource and connection identity, parser name and version, and ingestion time. lw_observables contains security observables extracted by the connector. See Connector output tables.
Connector output table schema
The destination includes the source and event columns below, together with the lw_meta and lw_observables columns described above.
The following schema includes the Zendesk Support audit log fields. For field definitions, see the Zendesk Support connector reference and the Zendesk Audit Logs API.
Schema
| Column | Data type |
|---|---|
lw_id |
STRING |
time |
TIMESTAMP |
action |
STRING |
action_label |
STRING |
actor_id |
BIGINT |
actor_name |
STRING |
change_description |
STRING |
created_at |
STRING |
ip_address |
STRING |
source_id |
BIGINT |
source_label |
STRING |
source_type |
STRING |
url |
STRING |
Security observables
The connector extracts the following fields into lw_observables.
Observables
| Field | Indicator |
|---|---|
actor_name |
username |
ip_address |
ip |
url |
url |