Here's an explanation of each property you might find in the body of any request Upsales posts to your app.
General app information
These properties are available on all requests.
appId (number)
The id of your app in the Upsales App Directory.
date (string)
The UTC date and time the request was sent, in the format YYYY-MM-DD HH:mm:ss (for example 2026-10-07 14:30:00). It has no time zone designator.
authenticationKey (string)
To verify the request is from Upsales
apiPath (string)
The base URL of the Upsales API to call with the apiKey, for example https://power.upsales.com/api/. Use this value instead of a hardcoded host.
currentDomain (string)
The address of the Upsales web app, for example https://power.upsales.com.
ENV (string)
The Upsales environment that sent the request: PRODUCTION for production accounts and SANDBOX for sandbox accounts.
Customer object
An object with information about the Upsales account the app runs for. This object is available on all requests and has the folllowing properties.
customer.id (number)
The Upsales customer id the app runs for
customer.name (string)
The name of the customer
Customer config properties
All of these properties are available on most requests. Only the config object is available on test or fieldValues requests.
config (object)
The configuration this customer has set up for your app (or is trying to set up if the request is a test request). See app json for more information.
version (string)
The version of your app this customer has configured. (could differ from the current version of your app).
appData (object)
Any appData your app has saved previously for this customer. See app callback for more information.
apiKey (string)
An API key for this customer to the Upsales API. Only available if your app is set to use API key.
userApiKey (string)
An API key to the Upsales API for the user the request is for. Only available if your app is set to use API key and each user activates the app for themselves.
User object
Information about the user that initiated the request, or the request was initiated for.
Some requests, such as non-user configurable apps that are initiated as a scheduled job or manually, don't have a user scope and will not have this object.
user.id (number)
The Upsales id of this user. Please note, this is not a global id for all Upsales users - but an id for this Upsales account. For example, two different Upsales account can have a user with id 1.
user.name (string)
The full name of the user
user.email (string)
You guessed it - the users email address.
user.language (string)
The language preference for this user.
user.administrator
Set to a truthy value if the user is an administrator in this Upsales account.
user.billingAdmin
Set to a truthy value if the user is a billing admin in this Upsales account.
user.roleId (number)
The id of the user's role in this Upsales account.
user.integrationId (number)
If the request was triggered by a call to the Upsales API made with an app's API key, the id of that app. Otherwise null.
user.params (object)
User settings. Contains timeZone (string, the user's time zone, for example Europe/Stockholm) and exchangeSync (boolean).
User config properties
If your app is user configurable, the following properties will be sent in most requests. Only the userConfig object is available on test or fieldValues requests.
userConfig (object)
The configuration this user has set up for your app (or is trying to set up if the request is a test request). See app json for more information.
userVersion (string)
The version of your app this user has configured. (could differ from the current version of your app as well as the version property).
userAppData (object)
Any userAppData your app has saved previously for this user. See app callback for more information.
OAuth properties
If your app has a field of type oauth, these properties are sent in the oauthToken request Upsales makes to your app when a user connects the field.
code (string)
The authorization code that was returned to Upsales.
state (string)
The state value Upsales sent when it opened the field's endpoint.
callbackPath (string)
The callbackPath value Upsales sent when it opened the field's endpoint, without its query string.
Other properties
callbackUrl (string)
A URL to post app callback to. See app callback for more information.
data
Any data related to the request. The type will differ depending on the request.