Tracking Events List

  The list of all our predefined events is available here, as well as custom events you can send from anywhere with a POST request. You can read more about the endpoint and authentication over on our API Rest Documentation.

Listed here are the request types and what the request body should be for every request.

UpdateCart

Use this event to update all the cart content of a contact.

There is no need of quantity per product but only a array of products.

{
    "event": "UpdateCart",
    "body": {
        "email": "customer@email.com",
        "content_ids": ["product_id_1", "product_id_2],
        "value": 100,
        "currency": "USD"
    }
}

Purchase

{
    "event": "Purchase",
    "body": {
        "order_id": "123456ASD", // Must be unique
        "email": "customer@email.com",
        "content_ids": ["product_ids", "products_1"],
        "value": 100,
        "currency": "USD"
    }
}

Purchase Update

{
    "event": "PurchaseUpdated",
    "body": {
        "status": "PENDING",
        "email": "demo@flashyapp.com",
        "order_id": "__ORDER_ID__",
        "content_ids": ["product_id"], // Optional
        "value": 100, // Optional
        "currency": "USD" // Optional
    }
}

Custom Event

{
    "event": "CustomEvent",
    "body": {
        "email": "customer@email.com",
        "event_name": "SomeAction"
    }
}

Add Extra Information with Context

Many times we want to track more information into an event that has happened and use that information within the customer's journey and the messages we send.

The way to do this is to add the following code to the event:

{
    "event": "CustomEvent",
    "body": {
        "email": "customer@email.com",
        "event_name": "SomeAction",
        "context": {
            "key_1": "can be anything",
            "key_2": "helpful information"
        }
    }
}

In order to use this information in the messages you send you can use: {{context.key_1}}

And we will pull this information from the event.