Här förklaras varje egenskap som kan finnas i body för de anrop som Upsales skickar (POST) till din app.

Allmän appinformation

De här egenskaperna finns i alla anrop.

appId (number)

Din apps id på sidan Appar i Upsales.

date (string)

Datum och tid i UTC när anropet skickades, i formatet YYYY-MM-DD HH:mm:ss (till exempel 2026-10-07 14:30:00). Värdet har ingen tidszonsbeteckning.

authenticationKey (string)

För att verifiera att anropet kommer från Upsales

apiPath (string)

Bas-URL:en till Upsales API som du anropar med apiKey, till exempel https://power.upsales.com/api/. Använd det här värdet i stället för en hårdkodad host.

currentDomain (string)

Adressen till Upsales webbapp, till exempel https://power.upsales.com.

ENV (string)

Den Upsales-miljö som skickade anropet: PRODUCTION för produktionskonton och SANDBOX för sandbox-konton.

Customer-objektet

Ett objekt med information om det Upsales-konto som appen körs för. Objektet finns i alla anrop och har följande egenskaper.

customer.id (number)

Upsales kund-id för den kund som appen körs för

customer.name (string)

Kundens namn

Egenskaper för kundens konfiguration

Alla de här egenskaperna finns i de flesta anrop. I test- och fieldValues-anrop finns bara config-objektet.

config (object)

Den konfiguration som kunden har ställt in för din app (eller försöker ställa in, om det är ett testanrop). Mer information finns under app json.

version (string)

Den version av din app som kunden har konfigurerat (kan skilja sig från appens aktuella version).

appData (object)

Eventuell appData som din app tidigare har sparat för kunden. Mer information finns under app callback.

apiKey (string)

En API-nyckel till Upsales API för kunden. Finns bara om din app är inställd på att använda API-nyckel.

userApiKey (string)

En API-nyckel till Upsales API för den användare som anropet gäller. Finns bara om din app är inställd på att använda API-nyckel och varje användare aktiverar appen för sig själv.

User-objektet

Information om den användare som startade anropet, eller som anropet startades för.

Vissa anrop saknar användarkontext och har därför inte det här objektet, till exempel anrop från appar som inte konfigureras per användare och som startas som ett schemalagt jobb eller manuellt.

user.id (number)

Användarens id i Upsales. Obs! Det är inte ett globalt id för alla Upsales-användare utan ett id inom just det här Upsales-kontot. Två olika Upsales-konton kan till exempel båda ha en användare med id 1.

user.name (string)

Användarens fullständiga namn

user.email (string)

Du gissade rätt – användarens e-postadress.

user.language (string)

Användarens språkinställning.

user.administrator

Har ett truthy-värde om användaren är administratör i det här Upsales-kontot.

user.billingAdmin

Har ett truthy-värde om användaren är faktureringsansvarig i det här Upsales-kontot.

user.roleId (number)

Id för användarens roll i det här Upsales-kontot.

user.integrationId (number)

Om anropet utlöstes av ett anrop till Upsales API med en apps API-nyckel: den appens id. Annars null.

user.params (object)

Användarinställningar. Innehåller timeZone (string, användarens tidszon, till exempel Europe/Stockholm) och exchangeSync (boolean).

Egenskaper för användarens konfiguration

Om din app konfigureras per användare skickas följande egenskaper i de flesta anrop. I test- och fieldValues-anrop finns bara userConfig-objektet.

userConfig (object)

Den konfiguration som användaren har ställt in för din app (eller försöker ställa in, om det är ett testanrop). Mer information finns under app json.

userVersion (string)

Den version av din app som användaren har konfigurerat (kan skilja sig både från appens aktuella version och från egenskapen version).

userAppData (object)

Eventuell userAppData som din app tidigare har sparat för användaren. Mer information finns under app callback.

OAuth-egenskaper

Om din app har ett fält av typen oauth skickas de här egenskaperna i det oauthToken-anrop som Upsales gör till din app när en användare kopplar fältet.

code (string)

Den auktoriseringskod som returnerades till Upsales.

state (string)

Det state-värde som Upsales skickade när fältets endpoint öppnades.

callbackPath (string)

Det callbackPath-värde som Upsales skickade när fältets endpoint öppnades, utan query string.

Övriga egenskaper

callbackUrl (string)

En URL som app callback ska skickas (POST) till. Mer information finns under app callback.

data

Eventuell data som hör till anropet. Typen skiljer sig beroende på anrop.