General

To activate an app as a data source, turn on the Data source toggle under Frameworks. Then, continue to configure the app as specified by the documentation below. For a full example of how the config may look see Figure 1. For general app configuration, e.g. user configurable fields, see Upsales app documentation.

Upsales sends every request to your app as a POST with a JSON body, and your app endpoint must use HTTPS. Your app has 30 seconds to respond.

Capabilities config

The following fields can be configured under capabilities. Your app is listed in the add new company modal only if capabilities.typeahead is set, and in the update/connect company dialog only if capabilities.refresh is set.

Table 1

Properties for the capabilities config object

Table 2

Properties for a pricing option

Typeahead config

This is the configuration for the add new company modal. Each search is sent to your app as a filter on name, or on orgNo when the search text looks like an organisation number. The following fields can be configured under typeahead:

Table 3

Properties for the typeahead config object 

Table 4

Properties for the pagination config object

Table 5

Properties for the countryTabs config object 

Columns

The following attributes can be configured for columns 

Table 6

Properties for a Column config object   

Table 7

The different types of columns 

Refresh config 

This is the options for the update/connect company button in the company view. The following fields can be configured under refresh:

iFrame configuration

To show your app in an iframe on the company card, set iframe=true in the outermost layer of the config. The app's icon is shown next to its name. When a user opens the app on a company, Upsales sends a POST request to your app on /iframe with the company under body.data (its id is body.data.id). Respond with the URL of the page to show in the iframe.

Example

Figure 1. An example config for a data source app

{
    "fields": {
        "account": [
            {
                "type": "multiselect",
                "name": "countries",
                "label": "Countries",
                "required": true,
                "externalValues": true
            },
            {
                "type": "checkbox",
                "name": "createContacts",
                "label": "Create contacts"
            }
        ],
        "user": [],
        "test": true
    },
    "uiElements": {
        "account": {
            "sidebar": [
                {
                    "name": "monitoring",
                    "type": "iframe"
                }
            ]
        }
    },
    "requirements": [],
    "capabilities": {
        "logo": "https://img.upsales.com/app/102/logo.png",
        "match": {
            "upsales": "dunsNo",
            "integration": "dunsNo"
        },
        "pricing": {
            "buy": {
                "endpoint": "buy",
                "cost": 0,
                "text": {
                    "en": "Basic data",
                    "sv": "Basdata"
                }
            }
        },
        "typeahead": {
            "idField": "dunsNo",
            "pagination": {
                "enabled": true
            },
            "countryTabs": {
                "enabled": false
            },
            "columns": [
                {
                    "type": "string",
                    "header": "Company name",
                    "field": "name",
                    "width": "70%"
                },
                {
                    "type": "add",
                    "width": "30%"
                }
            ]
        },
        "refresh": {
            "columns": [
                {
                    "type": "string",
                    "header": "Company name",
                    "field": "name",
                    "width": "70%"
                },
                {
                    "type": "add",
                    "width": "30%"
                }
            ]
        }
    },
    "iframe": true
}