6.5. Events reference

Below are the events which are currently implemented for tracking user engagement.

Note

Events are sent in bulk as a JSON array.

6.5.1. Click event

A click event is generated when a user clicks on a link that has been rewritten in an email. It is described by, and can be validated with, the submission-tracking-click.schema.json JSON schema.

{
    "type": "click",
    "event_id":  "325128fc-b5a6-11ec-b8dd-000c292d8854",
    "timestamp": "1649248573401",
    "recipient": "[email protected]",
    "message_id": "<36e76ce2-b5a6-11ec-b8dd-000c292d8854@c568c9a1654f>",
    "ip": "1.2.3.4",
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.3 Safari/605.1.15",
    "url": "http://example.com/example/path",
    "additional": {}
}

6.5.2. Open event

An open event is generated when a user loads the tracking pixel in an email. It is described by, and can be validated with, the submission-tracking-open.schema.json JSON schema.

{
    "type": "open",
    "event_id":  "3f01df67-b5a6-11ec-b8dd-000c292d8854",
    "timestamp": "1649248582414",
    "recipient": "[email protected]",
    "message_id": "<469c01df-b5a6-11ec-b8dd-000c292d8854@c568c9a1654f>",
    "ip": "1.2.3.4",
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.3 Safari/605.1.15",
    "additional": {}
}

6.5.3. Unsubscribe event

An unsubscribe event is generated when a user does a one-click list unsubscribe on an email. It is described by, and can be validated with, the submission-tracking-unsubscribe.schema.json JSON schema.

{
    "type": "unsubscribe",
    "event_id":  "3f01df67-b5a6-11ec-b8dd-000c292d8854",
    "timestamp": "1649248582414",
    "recipient": "[email protected]",
    "message_id": "<469c01df-b5a6-11ec-b8dd-000c292d8854@c568c9a1654f>",
    "ip": "1.2.3.4",
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.3 Safari/605.1.15",
    "additional": {}
}