File-based Events
Understand when to send event files to Extole, our file naming conventions, and more.
Overview
Extole supports regular file uploads to receive events that may have happened offline or are otherwise unable to be tracked through tags or API.
Example Events for Different Programs
| ONLINE RETAIL | PAID SUBSCRIPTION | BANKING |
|---|---|---|
purchasedshippedcanceledreturned | registeredsubscribedpaidcanceled | application_startedappliedopenedfundedtransactedclosed |
File Naming Conventions
The file should be uploaded to the Extole SFTP system at: [email protected]:/events.
For details on using SFTP and the Extole SFTP Server, check out our article on Using Extole's SFTP Server.
You can also access the interface in My Extole to view file processing in the Tech Center. This interface will allow you to upload, download, and view files and subscribe to failure alerts.
Event File Records
| Column Name | Required | Description |
|---|---|---|
event_name | Yes | The type of event to create such as:purchasedshippedopenedcanceled |
email | Yes | The email of the person who did the event (e.g. the email of the person who made the purchase, opened the account, etc.). |
first_name | No | The first name of the person who did the event. |
last_name | No | The last name of the person who did the event. |
coupon_code | No | The unique one-time use coupon code used in the event (e.g. in the purchase). This coupon code must have been issued as part of the Extole incentive. |
event_time | No | The date and time of the event as ISO_8601 format. Generally this isYYYY-MM-DDThh:mm:ssZ (e.g. 2013-08-11T14:33:18-0700). If not provided, Extole will use the processing time of the event file as the event time. |
partner_event_id(renameable) | No | This is your unique identifier for the event. This could be an order number, confirmation number, or other unique identifier. Passing this is strongly recommended to make sure duplicate transactions are never created. |
partner_user_id(renameable) | No | This is your unique identifier for the person who did the event. This is useful for ensuring that the event is tied to the proper user. |
cart_value | No | Revenue value of the transaction before coupons are applied, used for reporting. |
container | No | The container where the events should appear. Use production if you want the events to appear in your analytics, or test, which causes Extole to not summarize the data in the program and campaign summary analytics |
Advocate Recognition
You should provide all transactions to Extole and the transactions will be run through the Extole advocate recognition process to find referrals based on coupon code, friend email address, partner user ID, partner conversion ID.
Configurable and Renameable Fields
There are no "standard events" with Extole, only your specified business events. In other words, it's possible to send any event to Extole.
All of the names of data elements for events can be renamed and additional data fields can be passed to be used for targeting, personalization, quality, and reward rules.
Input File Example
Filename: /events/events_20130619000000.csv
event_name,email,member_id,event_time
account_opened,[email protected],AAA123,2013-06-19T10:12:53-0700
account_opened,[email protected],AAA124,2013-06-19T11:42:51-0700
account_opened,[email protected],AAA125,2013-06-19T12:16:12-0700
event_name,email,member_id,event_time,value
account_qualified,[email protected],AAA123,2013-06-19T10:12:53-0700,25.23
account_qualified,[email protected],AAA124,2013-06-19T11:42:51-0700,21.00
account_qualified,[email protected],AAA125,2013-06-19T12:16:12-0700,722.00
event_name,email,coupon_code,event_time,order_id,cart_value
purchase,[email protected],AAA123,2013-06-19T10:12:53-0700,00540000001PULM,20.34
purchase,[email protected],AAA124,2013-06-19T11:42:51-0700,00540000001O1fi,100.28
purchase,[email protected],AAA125,2013-06-19T12:16:12-0700,0064000000QP7SN,99.99
For additional details on file requirements, see our docs: File Conventions
Updated 3 months ago