Interaction Studio Classic Only
- The contents of this article are intended for customers using Interaction Studio (formerly Evergage Classic). Do not adjust your beacon version to downgrade or upgrade.
- If you are a Campaigns & Templates customer, please refer to the CSV Feed Requirements in this knowledge base, or the Feeds article in developer.evergage.com.
- The Visual Editor Chrome Extension will no longer be available starting January 1, 2023. For more information, see this knowledge article.
Event HTTP Request Format Requirements
HTTP's GET and POST request methods are supported. GET is recommended for ease of use.
For POST requests,
content-type=application/x-www-form-urlencoded must be used (
content-type=multipart/form is not supported).
Each HTTP request represents a single event. Request parameters are interpreted as event fields. Fields beginning with an underscore ("_") are reserved for metadata that are used in event processing. All other parameters will be stored in the dataset. Events sent to the httpreceiver endpoint can have arbitrary parameters and values, but must always include the account key ("_ak") and dataset (“_ds”) parameters. The event may also optionally include a “_time” parameter that sets the timestamp of the event in epoch milliseconds. If not included, the system will assign the current time as the event's timestamp.
|_ak||Interaction Studio account ID||Identifier of your account in Interaction Studio (same as your subdomain .evergage.com).|
|_ds||Interaction Studio dataset ID||Identifier of your dataset in Interaction Studio|
|_time||Event time||Optional||Event timestamp in epoch milliseconds. Optional–if omitted, current time is used.|
|userId||ID of the user||ID of the named user to associate with this event|
|company||Company/account of user||Optional||For datasets tracking accounts, this identifies which account the user belongs to. If omitted, user's existing account association will be used.|
|action||Action name||Name of the action that the user just took.|
|<custom>||Custom attribute||Optional||Specify any additional custom attributes for the user or account that you wish to set.|
Endpoint Address, Transport & Response Detail
Event HTTP requests should use the path of your account-specific
httpreceiver endpoint, which is:
It is recommended to use HTTPS (SSL) when possible, but plaintext HTTP is also accepted. Events received successfully will get an HTTP response status code of 200. If there is a problem with the message, such as a missing dataset parameter, a 400 error code will be returned.
Character Encoding, URI Encoding
For best results:
- Prepare your Event data in UTF-8
- For POST requests, explicitly declare UTF-8 as the request's character encoding:
Content-type: application/x-www-form-urlencoded; charset=UTF-8
- For GET and POST requests, perform URI encoding on all parameter names and values using UTF-8.
- If you are using an HTTP client library (e.g. Apache HttpClient, Ruby's rest-client etc.), check the default behavior to ensure you are not double-encoding.