explain
Dry-run an event for a recipient to see which rules would fire, their outcomes, and why others wouldn't, before sending. Nothing is stored or sent.
Instructions
Dry-run an event for a person: which rules would fire, what each would do and why the others would not. Use it before send_event to check that a rule will reach the person; nothing is stored or sent. Needs an admin key, so agent keys get 403 and should read get_event for a real event instead.
Returns rules, one entry per rule listening for the name, with rule, matched, status (what the message would get, e.g. queued or suppressed), reason and digest_id, read like get_event's outcome. Fails with 404 when recipient does not exist yet.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | Event details to test conditions with, as for send_event. | |
| recipient | Yes | External id of an existing recipient; unlike send_event, an unknown id is not created. | |
| event_name | Yes | Event name to test, as for send_event, e.g. `order.shipped`. |