Server 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.

Method: POST

URI: /users/v1/individual/{uid}/customevent

Path Parameters

uidstringThe unique ID you've given to the user. You will have passed that ID through the FS.identify Browser API function.

Request Body Schema

event_namestringThe unique name of the custom event. [required]
event_dataobjectA set of key-value pairs listing the event properties and values. Property names must follow the custom field format documented here.
timestamptimestampThe time the event occurred, represented in ISO 8601 format. If not provided, the current FullStory server time will be used.

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.

There are three ways to associate an event to a user session. The session-related fields below are all optional. You may include only one of these fields for each event:

session_urlstringThe FullStory session playback URL to which the event should be attached, as returned by the FS.getCurrentSessionURL() client API.
use_recent_sessionbooleanSet to true if the custom event should be attached to the user’s most recent session. The most recent session must have had activity within the past 30 minutes.
device_sessionstringThe device session identifier, as returned by the FS.getCurrentSession() client API.

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.

Request Headers

Authorization: Basic {YOUR_API_KEY}

Status Codes

200: A successful response.

400: Bad request - the request payload is malformed.

404: Unknown user - the specified uid does not exist in FullStory.

429: Too many requests. Client has exceeded the rate limit for this endpoint.