Event Types

We support Detailed Events (Impressions and Clicks) and Click events via webhooks. Each event has its resources that can be referred from the resource column.

Clickstream Webhook Event Structure

event_id	UUID / String	Unique identifier for the user event. This groups all related actions for a single campaign interaction. To be generated from BE.	No
reference_id	String	Mapped as an external reference to a user phone number. Can be in following formats : The raw 12 digit phone number (with 2-digit country code) of the user who saw the campaign impression. The SHA256 hashed value of the 12 digit phone number (with 2-digit country code) of the user who saw the campaign impression. The reference_id of the user who saw the campaign impression; mapped to the optional reference_id field in the Payload Exchange API	Yes
organisation_id	String	Identifier for the Organisation associated with the event.	No
campaign_id	String	Identifier for the campaign associated with the event.	No
display_unit	String	Identifier for the display unit where the event was served.	No
impression_timestamp	Timestamp	The exact date and time when the impression was served.	No
click_timestamp	Timestamp (Optional)	The exact date and time when the click event occurred. Only populated if a click happened.	No
business_number	String	The business phone number/sender id which triggered the campaign to the end user.	No

// Event Structure for Clickstream - Detailed Events

{
    "event_id": "DfK910987654321SNJ",
    "reference_id": "911234567890",
    "organisation_id": "HHSDFZX1234592828SJ299",
    "campaign_id": "Test_campaign",
    "display_unit": "business-profile",
    "impression_timestamp": "1754116200",
    "click_timestamp": "1754118000",
    "business_number": "9122245644890"
}

// Event Structure for Clickstream - Click Events

{
    "event_id": "DfK910987654321SNJ",
    "reference_id": "911234567890",
    "organisation_id": "HHSDFZX1234592828SJ299",
    "campaign_id": "Test_campaign",
    "display_unit": "business-profile",
    "impression_timestamp": "1754116200",
    "click_timestamp": "1754118000",
    "business_number": "9122245644890"
}