Automation events
Note: Your integration may add custom parameters. The tables only list parameters that exist in Synerise and SDKs/APIs by default.
attachment.expired
An attachment has expired and cannot be used in the Send email node as a dynamic attachment.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that exist in all events |
| params | array of objects | "params": [{"mimeType": "text/csv","id": "ad7e1e7e-16bb-476b-805d-767159619c9c","minioBucketName": "3d2bbac6f7eacc33da9c9f4299c3154c49965926","filename": "Policy certificate","extension": "csv","path": "/113ad6144463ea34ff9b778e544464b4bb5644bf/ea3d2fe6-13ed-412a-9a0d-1470f447890c","size": 48}] |
An array of file parameters |
attachment.failed
An upload of an attachment failed and the file cannot be used in the Send email node as a dynamic attachment.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that exist in all events |
| params | array of objects | "errors": [{"source": null,"timestamp": "2023-07-31T09:24:13.093001074Z","field": "mimetype/extension","errors": [],"help": null,"errorCode": "UPL-001","httpStatus": 400,"details": {"filename": "Policy certificate","mimetype": "ghj/csv","extension": "csv"},"message": "Wrong mime type or extension","traceId": "7451773f1a4468d6"}] |
An array of file parameters |
attachment.upload
A base64 encoded file has been uploaded successfully and it is ready to be used as a dynamic attachment in the Send email node.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that exist in all events |
| params | array of objects | "params": [{"attachment.0.size": 48,"attachment.0.filename": "Policy certificate","attachment.0.extension": "csv","attachment.0.mimeType": "text/csv","attachment.0.id": "ad7e1e7e-16bb-476b-805d-767159619c9c","attachments": [{"mimeType": "text/csv","id": "ad7e1e7e-16bb-476b-805d-767159619c9c","minioBucketName":"3d2bbac6f7eacc33da9c9f4299c3154c49965926","filename": "Policy certificate","extension": "csv","path": "/113ad6144463ea34ff9b778e544464b4bb5644bf/ea3d2fe6-13ed-412a-9a0d-1470f447890c","size": 48}] |
An array of file parameters |
automation.abTestVariantAssigned
A profile reached the ABx Test node and A/B/X test variant has been assigned to them.
This event is generated only after enabling the Generate a variant assignment event option in the configuration of the node.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that exist in all events |
| diagramId | string | c819738e-2d61-482c-a680-75ebdbc9a762 |
Unique ID of the Automation workflow that caused this event (if applicable) |
| diagramName | string | Abandoned cart emails |
Name of the workflow |
| blockId | string | a920849d-3e72-593d-b791-86fcecd0b873 |
Unique ID of the node on the canvas |
| blockName | string | Assign a customer to a variant |
Name of the node defined by the user |
| variantName | string | Group A |
Name of the variant (group) to which a profile has been assigned |
| variantIndex | number | 1 |
The number of path that leads the profile further in the workflow. |
automation.clientStartPath
A profile entered a workflow path.
Important: This event can’t be used as an automation trigger.
Default retention: 2 days
This event is necessary to store and read the current state of an Automation journey. It’s also used in debugging.
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that exist in all events |
| activatedBlockName | string | abandoned cart |
Name of the node that was activated in this step |
| journeyId | string | db0a9db2-8849-5c58-9871-e07d45d64bd7 |
Unique ID of the Automation workflow that caused this event (if applicable). If the Profile has a workflow in progress and enters it again, journeyId is the same, because it's the same workflow. |
| activatedBlockId | string | fc8248b3-fba1-41ad-8d55-1a255fbfe47c |
Unique ID of the node that was activated in this step |
| pathId | number | 1 |
ID of the path on which the activated node is placed |
| diagramId | string | c819738e-2d61-482c-a680-75ebdbc9a762 |
Unique ID of the Automation workflow that caused this event (if applicable) |
| _causalityId | number | 4 |
This parameter is used to sort events that occurred in the same second, so that they can be displayed in the correct order. |
| diagramName | string | Abandoned cart emails |
Name of the workflow |
automation.clientPathStep
A profile completed a step (node) in a workflow path.
Important: This event can’t be used as an automation trigger.
Default retention: 2days
This event is necessary to store and read the current state of an Automation journey. It’s also used in debugging.
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that exist in all events |
| activatedBlockName | string | abandoned cart |
Name of the node that was activated in this step |
| journeyId | string | db0a9db2-8849-5c58-9871-e07d45d64bd7 |
Unique ID of the Automation workflow that caused this event (if applicable). If the Profile has a workflow in progress and enters it again, journeyId is the same, because it's the same workflow. |
| activatedBlockId | string | fc8248b3-fba1-41ad-8d55-1a255fbfe47c |
Unique ID of the node that was activated in this step |
| pathId | number | 1 |
ID of the path on which the activated node is placed |
| diagramId | string | c819738e-2d61-482c-a680-75ebdbc9a762 |
Unique ID of the Automation workflow that caused this event (if applicable) |
| _causalityId | number | 4 |
This parameter is used to sort events that occurred in the same second, so that they can be displayed in the correct order. |
| diagramName | string | Abandoned cart emails |
Name of the workflow |
automation.clientEndPath
A profile completed a journey by reaching the End node in one of a workflow’s paths.
Important: This event can’t be used as an automation trigger.
Default retention: 2 days
This event is necessary to store and read the current state of an Automation journey. It’s also used in debugging.
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that exist in all events |
| activatedBlockName | string | abandoned cart |
Name of the node that was activated in this step |
| journeyId | string | db0a9db2-8849-5c58-9871-e07d45d64bd7 |
Unique ID of the Automation workflow that caused this event (if applicable). If the Profile has a workflow in progress and enters it again, journeyId is the same, because it's the same workflow. |
| activatedBlockId | string | fc8248b3-fba1-41ad-8d55-1a255fbfe47c |
Unique ID of the node that was activated in this step |
| pathId | number | 1 |
ID of the path on which the activated node is placed |
| diagramId | string | c819738e-2d61-482c-a680-75ebdbc9a762 |
Unique ID of the Automation workflow that caused this event (if applicable) |
| _causalityId | number | 4 |
This parameter is used to sort events that occurred in the same second, so that they can be displayed in the correct order. |
| diagramName | string | Abandoned cart emails |
Name of the workflow |
webhook.response
An outgoing webhook from an Automation returned a response.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that exist in all events |
| req.url | string | https://example.com/hook |
URL of the request |
| name | string | Pull data |
Name of the automation node |
| statusDescription | string | OK |
Status of the request |
| status | integer | 200 |
HTTP code of the request status |
| body.<keyPath> | string | exampleValue |
Data from the response body. Each property of the response body is saved as a separate parameter named after the dot notation path of the corresponding key. See example below the table. |
Response body properties example
For the following response body:
{
"prop1": "string",
"prop2": [
"value1",
"value2"
],
"prop3": {
"key1": true,
"key2": 15
}
}The following event params are generated:
| Name | Value |
|---|---|
body.prop1 |
string |
body.prop2[0].someKey |
123 |
body.prop2[1].someKey |
456 |
body.prop3.key1 |
true |
body.prop3.key2 |
15 |
