Email send event
Triggered when an Mautic sends an Email to a Contact.
Event type
mautic.email_on_send
Event properties
Key |
Type |
Description |
---|---|---|
|
object |
|
|
object |
|
|
object |
Key/value pairs of personalized tokens and values for the Contact. |
|
string |
Identifies the unique Email content including template. |
|
string |
Unique to the specific Email send to the Contact. |
|
string |
The HTML sent to the Contact. |
|
string |
The rendered subject of the Email sent to the Contact. |
|
array |
The Component that sent the Email. Key 0 is the Component and key 1 is the ID if applicable. For example, if a Campaign sent the Email, this value is |
|
object |
Key/value pairs of headers set on the Email sent to the Contact. |
|
string |
Date/time the event occurred in ISO 8601 format. |
Email properties
Key |
Type |
Description |
---|---|---|
|
int |
ID of the Email |
|
boolean |
Published state of the Email. |
|
string |
Date/time of Email creation in ISO 8601 format. |
|
int|null |
The ID of the User who created the Email. |
|
string|null |
Name of the User that created the Email. |
|
string|null |
Date/time the Email was last modified in ISO 8601 format or null if not modified. |
|
int|null |
The ID of the User who last modified the Email or null if not modified. |
|
string|null |
Name of the User that last modified the Email if applicable. Otherwise null. |
|
string |
Internal name of the Email. |
|
string |
Subject of the Email. |
|
string |
Locale for the Email content. |
|
object |
|
|
string|null |
A custom from address if configured. |
|
string|null |
A custom from name if configured. |
|
string|null |
A custom reply to address if configured. |
|
boolean |
TRUE if a Contact’s Owner should the Email’s from address and name. |
|
string |
HTML template for the Email. |
|
string|null |
Plain text for the Email. |
|
string |
The Mautic Theme used as the originating content. |
|
string |
Type of Email. Options are |
|
int |
The number of opens for the Email. |
|
int |
The number of sends for the Email. |
|
int |
The number of edits for the Email. |
|
object[] |
Array of objects that contain the Dynamic Content configured as tokens for the Email. |
|
object |
Key/value pairs of UTM Tags as keys. Mautic supports the following keys: |
|
string|null |
Date/time for publishing the Email in ISO 8601 format. |
|
string|null |
Date/time for unpublishing the Email in ISO 8601 format. |
|
array |
Array of Asset objects. |
|
string|null |
Date/time the Email started to track A/B test statistics. |
|
int |
The number of times sent since the last edit to an A/B test Email. |
|
int |
The number of times read since the last edit to an A/B test Email. |
|
object|null |
Email object. The A test for an Email configured as an A/B test. |
|
array |
Array of Email objects. The B, C, D, and so forth tests for an Email configured as an A/B test. |
|
object|null |
Email object. The main translation of an Email configured to be a translation of another. |
|
array |
Array of Email objects. The translations of an Email configured to be a translation of another. |
|
object|null |
|
|
array |
|
|
array |
Key/value pairs of header templates configured for the Email. |
Category properties
Key |
Type |
Description |
---|---|---|
|
int |
ID of the Category |
|
string |
Title of the Category. |
|
string |
API name of the Category. |
|
string |
Description of the Category. |
|
string |
Hex code for the configured color for the Category. |
|
string |
The Component or Channel the Category is applicable. Can also be |
|
string |
Name of the User that created the Category. |
|
string|null |
Name of the User who last updated the Category. Null if not modified. |
Asset properties
Key |
Type |
Description |
---|---|---|
|
int |
ID of the Asset. |
|
string |
Title of the Asset. |
|
string |
API name of the Asset. |
|
string |
Description of the Asset. |
|
object |
|
|
int |
The number of edits of the Asset. |
|
string |
The configured locale for the Asset. |
|
string |
|
|
string|null |
The URL of the Asset if |
|
string |
File extension for the Asset. |
|
string |
File type for the Asset. |
|
int |
File size in bytes. |
|
int |
Total number of downloads of the Asset. |
uniqueDownloadCount |
int |
Number of Contacts that has downloaded the Asset at least once. |
|
boolean |
|
Segment properties
Key |
Type |
Description |
---|---|---|
|
int |
ID of the Segment. |
|
string |
Name of the Segment. |
|
string |
Name displayed in the Preference Center if |
|
string |
API name of the Segment. |
|
string |
Description of the Segment. |
|
object |
|
|
string |
The name of the User that created the Segment. |
|
string|null |
The name of the User that last modified the Segment. |
|
boolean |
|
|
boolean |
|
|
array |
Array of Segment filter objects. |
Segment filter properties
Key |
Type |
Description |
---|---|---|
|
string |
Notes how the filter relates to the filter before it. Options are |
|
string |
The field type for the filter. For example, it could be a custom field filter such as |
|
string |
Object the filter’s data belongs to. Currently supported values are |
|
string |
The filter’s field type that corresponds with the underlying data. Current options are |
|
mixed |
The value of the filter. |
|
mixed |
Value that displays in the UI for a lookup type field. For example, |
|
string |
The comparison operator for the filter. Available values vary based on what the filter supports and includes |
Unsubscribe Form properties
Key |
Type |
Description |
---|---|---|
|
int |
ID of the Form. |
|
string |
Title of the Form. |
|
string |
API name of the Form. |
|
string |
Description of the Form. |
|
object |
|
|
string |
Name of the User that created the Form. |
|
string|null |
Name of the User who last updated the Form. Null if not modified. |
|
string|null |
Date/time for publishing the Form in ISO 8601 format. |
|
string|null |
Date/time for unpublishing the Form in ISO 8601 format. |
|
string |
Cached rendered HTML for the Form. |
|
string|null |
Custom Mautic Theme used to style the Preview page or customize Form fields. See Customizing Forms. |
|
string |
Applicable values are |
|
string |
Notes the behavior of the Form after submission. Current supported values are |
|
string|null |
The URL to redirect a Contact to if |
|
boolean |
|
|
boolean |
|
|
boolean |
|
|
string|null |
HTML attributes added to the <form> tag. |
|
array |
Array of Unsubscribe Form field objects |
|
array |
Array of Unsubscribe Form action objects |
Unsubscribe Form field properties
Key |
Type |
Description |
---|---|---|
|
int |
ID of the Form field. |
|
string |
API name for the Form field. |
|
string |
Label for the Form field. |
|
boolean |
|
|
string |
The Form field’s type. For example, |
|
mixed |
Default value for the Form field. |
|
boolean |
|
|
string|null |
Message to display if empty when a mandatory field. |
|
string|null |
Message to display in the Form’s HTML as instructions for the field. |
|
int |
Placement of the field within the order of Form fields. |
|
object |
Mix of properties specific to the Form field’s |
|
string|null |
HTML attributes to append to the field’s label element. |
|
string|null |
HTML attributes to append to the field’s input element. |
|
string|null |
HTML attributes to append to the field’s wrapping element. |
|
string|null |
The Contact custom field to persist the data to upon submit. |
|
boolean |
|
|
boolean |
|
Unsubscribe Form action properties
Key |
Type |
Description |
---|---|---|
|
int |
ID of the Form. |
|
string |
Name for the Form action. |
|
string |
Description for the Form action. |
|
string |
API name for the Form action. For example, |
|
int |
Placement of the action within the order of execution for the Form actions. |
|
object |
Mix of properties specific to the Form action’s |