Skip to main content
Version: v2

Introduction​

The Events API provides access to create custom events.

Version: v2

Authentication​

The HTTP API requires an API key that you can generate from the Fullstory app. The API key must have Admin or Architect level permissions for requests which retrieve data. The header value takes the form "Basic {YOUR_API_KEY}".

Security Scheme Type:apiKey
Header parameter name:Authorization

Associating events with sessions and users​

Server events can be "stitched" into existing Fullstory sessions by setting the session.id or by utilizing session.use_most_recent when identifying by user. However, it's important that you provide only one form of identification. Otherwise, the request will fail and you'll receive a 400 error in response.

Click to open the visual guide below or refer to the information that follows for how to approach associating events with sessions and users.

Server Event Flow Logic

Associating server events with an existing session

You may already have a session ID, for example by using the browser API to retrieve the session ID. If this is the case, you can associate the created server event with the session.

  • If you have a Fullstory session.id, set the session.id and don't set any other user or session properties.
  • If you have a session id from another system, the create event API does provide an option for setting the session.uid. However, the Browser and Mobile APIs don't currently provide a way to set the session.uid with a session id from another system. Therefore, this method is not supported.

If you don't have a session ID, but you're able to identify the user and would like Fullstory to try to associate the event with an existing session, you can associate the event with a user.

  • If you have a Fullstory user.id, set user.id and set session.use_most_recent to be true. Don't set any other user or session properties.
  • If you have user ID from another system, set user.uid and set session.use_most_recent to be true. Don't set any other user or session properties. This approach assumes that you're already identifying unique users.

Fullstory will try to associate the created event with an existing session or user with the information you provided.

Associating server events with a user, but not a session

In cases where you don't want the server event to be associated with a session, you can still create the event and associate it with a user.

  • If you have a Fullstory user.id, set user.id and don't set any other user or session properties.
  • If you have user ID from another system, set user.uid and don't set any other user or session properties. This approach assumes that you're already identifying unique users.

Create events that aren't associated with sessions or users

If you create an event that has no user or session information, Fullstory will create a new user to associate with that event. The user's name will appear as "(No name available)" within the user interface.

Effects of events on session and server event quota​

This is how created server events affect your session and server event quotas:

  • Session Quota: When a server event is associated with an existing session, it will not affect your server event quota. The event's corresponding session is already included as part of your account's session quota.
  • Server Event Quota: When a server event is associated with a user but not a session, the event will be counted as part of your account's server event quota.