Skip to content

chore: update Ansible specific notif data input docs #840

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 14, 2025
Merged

chore: update Ansible specific notif data input docs #840

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/concepts/policy/notification-policy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,26 @@ This is the schema of the data input that each policy request can receive:

The final JSON object received as input will depend on the type of notification being sent. Event-dependent objects will only be present when those events happen. The best way to see what input your Notification policy received is to [enable sampling](../policy/README.md#sampling-policy-inputs) and check the [Policy Workbench](../policy/README.md#policy-workbench-in-practice), but you can also use the table below as a reference:

### Ansible vendor changes structure

For Ansible runs, the `changes` array contains objects with different `action` values and `entity` objects that contain Ansible-specific fields:

```json
"changes": [
{
"action": "string enum - changed | ok | skipped | rescued | ignored | unreachable | failed",
"entity": {
"host_name": "string",
"playbook_name": "string",
"role_name": "string",
"task_name": "string",
"task_action": "string"
},
"phase": "string enum - plan | apply"
}
]
```

| Object Received | Event |
| ------------------- | -------------------------------------------------------------------- |
| `account` | Any event |
Expand Down