Set User Events
Capture custom events for users who have previously been identified in the browser via the FS.identify Browser API function. Use this API to track events from other systems that do not originate directly from the browser or mobile device.
Anonymous users
This API will only work for previously-identified users for whom the FS.identify or FS.setUserVars Browser API was called. Anonymous users lack the required uid
necessary for this API to function. You may want to associate server events with a Fullstory session. This is useful if the event occurred as a result of the user’s online activity and you want the user session to reflect both online and server activity. Example: capturing payment gateway errors during checkout.
Session Related Event
There are three ways to associate an event to a user session. The session-related fields are all optional. You may include only one of these fields for each event: session_url
, use_recent_session
, and device_session
If none of the fields above are provided, or if the event timestamp falls outside the 30-minute recent activity window, the event still be ingested, but will not be associated with an existing user session. The event can be used in other analyses such as Metrics, Funnels, Journeys, and Conversions.
Path Parameters
The application-specific ID you've assigned to this user.
Request Body required
event object optional
A successful response.
POST /users/v1/individual/{uid}/customevent
Authorization: ApiKeyAuth
name: Authorizationin: headertype: apiKey
https://api.fullstory.com/users/v1/individual/{uid}/customevent
- cURL
- Python
- Go
- Javascript
curl -L -X POST 'https://api.fullstory.com/users/v1/individual/:uid/customevent' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic <API_KEY_VALUE>' \
--data-raw '{
"event": {
"event_name": "Support Ticket",
"event_data": {
"id_int": 424242,
"priority_str": "Normal",
"source_str": "Email",
"title_str": "Account locked out"
},
"timestamp": "2022-03-15T14:23:23Z",
"use_recent_session": true
}
}'
curl -L -X POST 'https://api.fullstory.com/users/v1/individual/:uid/customevent' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic <API_KEY_VALUE>' \
--data-raw '{
"event": {
"event_name": "Support Ticket",
"event_data": {
"id_int": 424242,
"priority_str": "Normal",
"source_str": "Email",
"title_str": "Account locked out"
},
"timestamp": "2022-03-15T14:23:23Z",
"use_recent_session": true
}
}'
curl -L -X POST 'https://api.fullstory.com/users/v1/individual/:uid/customevent' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic <API_KEY_VALUE>' \
--data-raw '{
"event": {
"event_name": "Support Ticket",
"event_data": {
"id_int": 424242,
"priority_str": "Normal",
"source_str": "Email",
"title_str": "Account locked out"
},
"timestamp": "2022-03-15T14:23:23Z",
"use_recent_session": true
}
}'
curl -L -X POST 'https://api.fullstory.com/users/v1/individual/:uid/customevent' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic <API_KEY_VALUE>' \
--data-raw '{
"event": {
"event_name": "Support Ticket",
"event_data": {
"id_int": 424242,
"priority_str": "Normal",
"source_str": "Email",
"title_str": "Account locked out"
},
"timestamp": "2022-03-15T14:23:23Z",
"use_recent_session": true
}
}'