Events

Best Practices

We strongly recommend that you send Extole all conversion-type events. Extole will determine if events were caused by referrals or other engagement activities by running the events through our attribution engine.

Some methods of attribution include:

Advocate Code
Coupon Code provided by referrals
Partner User Id that matches a referred registration event
Friend Email address that recently received a share message

Example Events for Different Programs

Online Retail	Paid Subscription	Banking
PURCHASED SHIPPED CANCELED RETURNED	REGISTERED SUBSCRIBED PAID CANCELED	APPLICATION_STARTED APPLIED OPENED FUNDED TRANSACTED CLOSED

Input Data Fields

Field	Description
data.conversion_id required	The unique identifier for the event that can later be used as a unique identifier to search for or approve the event. The event ID can be renamed and typically matches the event, for example: PURCHASED: order_id REGISTERED: user_id APPLIED: application_id This ID required to ensure there are no duplicate conversions sent to Extole and for report reconciliation. This ID can be a maximum of 38 characters.
data.partner_user_id recommended	Your unique identifier of the friend. This can tie back to the identifier passed in registration. This ID is required to tie a conversion back to a registration for a membership flow. This is most common when a friend follows a social link and registers. This user ID allows Extole to see if this user registered due to a referral.
data.email required	The email address of the friend converting. This is used to for quality control.
data.first_name	The first name of the friend converting.
data.last_name	The last name of the friend converting.
data.advocate_code	The advocate code used by the friend converting. This may or may not be the coupon code.
data.coupon_code	The coupon code used by the friend when converting.
data.cart_value recommended	The revenue value of the transaction. This is used for reporting.

Response Data Fields

Field	Description
polling_id	The polling ID is a unique event request ID that will become the event ID. Once a polling ID has been returned, the event has been successfully accepted by Extole and there is no method to poll further.
event_id	The event ID is a unique identifier for the event sent to Extole. Please note that if the event is not recognized as a referral event, then Extole will discard the event and not track it. This feature allows sending all events to Extole without exposing all events to tracking. Extole will only track events relevant to referrals.

Field

Description

polling_id

The polling ID is a unique event request ID that will become the event ID. Once a polling ID has been returned, the event has been successfully accepted by Extole and there is no method to poll further.

event_id

The event ID is a unique identifier for the event sent to Extole.

Please note that if the event is not recognized as a referral event, then Extole will discard the event and not track it.

This feature allows sending all events to Extole without exposing all events to tracking. Extole will only track events relevant to referrals.