Docs »

Automations »

Events »


mail.draft automation events can modify any property on a new or resumed draft after a worker clicks on a ‘Compose’ or ‘Reply’ button, but before the editor popup opens.

Automations on this event are cumulative – multiple automations can modify the draft, with subsequent changes on the same fields overwriting earlier ones.

When setting custom_fields:, their uri field can be used as the key instead of IDs. New custom field changes are merged with existing fields.


The automation event dictionary starts with the following values:

Key Type Notes
draft_* record The draft record. Supports key expansion.
is_resumed bool true if the draft was resumed, false if new


Key Type Notes
draft:params: dictionary A dictionary of draft parameter modifications