Skip to content

Commit c96ce60

Browse files
committed
chore: update Ansible specific notif data input docs
Updates notification policy data input documentation to include Ansible specific changes objects. Part of: spacelift-io/backend#10815
1 parent 46e7e7b commit c96ce60

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/concepts/policy/notification-policy.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,26 @@ This is the schema of the data input that each policy request can receive:
202202

203203
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:
204204

205+
### Ansible vendor changes structure
206+
207+
For Ansible runs, the `changes` array contains objects with different `action` values and `entity` objects that contain Ansible-specific fields:
208+
209+
```json
210+
"changes": [
211+
{
212+
"action": "string enum - changed | ok | skipped | rescued | ignored | unreachable | failed",
213+
"entity": {
214+
"host_name": "string",
215+
"playbook_name": "string",
216+
"role_name": "string",
217+
"task_name": "string",
218+
"task_action": "string"
219+
},
220+
"phase": "string enum - plan | apply"
221+
}
222+
]
223+
```
224+
205225
| Object Received | Event |
206226
| ------------------- | -------------------------------------------------------------------- |
207227
| `account` | Any event |

0 commit comments

Comments
 (0)