## Webhook payload

URL: https://docs.atlan.com/product/capabilities/governance/data-quality/references/webhook-payload-reference

> Event types, payload structure, and field definitions for data quality webhook events.

When you [configure a webhook](https://docs.atlan.com/llms/governance/data-quality/configure-webhooks/llms.txt) for data quality events, Atlan sends an HTTPS POST request to your endpoint each time a rule lifecycle or execution event occurs. This page documents the event types, payload structure, and field definitions your endpoint receives.

The top-level structure is the same for all event types.

```json
{
 "eventType": "<event-type>",
 "ruleData": { ... }
}
```

## Event types

Atlan sends webhook events for two categories: rule lifecycle changes and rule execution results.

### Rule lifecycle events

These events fire when a rule definition changes.

<!-- vale off -->

### Rule execution events

These events fire after a scheduled or on-demand rule run completes.

## `ruleData` field reference

Every event includes a `ruleData` object containing rule metadata, execution results, threshold configuration, and the associated dataset and column details. Fields are grouped below by function.

> *Example payload — see full content on the documentation site.*

### Rule identification

These fields identify the rule, its template, quality dimension, and priority.

### Execution results

These fields report the outcome and timing of the most recent rule run.

### Source sync

These fields indicate whether the rule result was synced back to the source warehouse.

### Row filtering

These fields describe the row-scope filtering and failed-rows query configuration for the rule.

### Custom SQL

These fields are populated only for rules that use the Custom SQL template. For other rule types, both fields return an empty string.

### `threshold`

The `threshold` object contains the pass/fail boundary configured for the rule.

### `baseDatasetInfo`

The `baseDatasetInfo` object identifies the table or view the rule is applied to.

### `baseColumnInfo`

The `baseColumnInfo` object identifies the column for column-level rules. For table-level rules, all fields return an empty string.

<!-- vale on -->

## See also

- [Configure webhooks](https://docs.atlan.com/llms/governance/data-quality/configure-webhooks/llms.txt): Set up webhook endpoints to receive data quality events
- [Configure alerts](https://docs.atlan.com/llms/governance/data-quality/configure-alerts/llms.txt): Configure Slack or Microsoft Teams notifications for data quality rule failures

---