App Integrator concepts
Application is a system that provides services over the internet. Albato has a library of 400+ Apps connected to the platform. Albato users can also add a new app in Albato themselves, if this app has an open API. This apps can be published for private or public use.
Request widget is a section where users configure HTTP requests to the API, along with outgoing request, response parser and error handling. This section appears in all entities that make API requests.
Connection is an integration between Albato and your account in another app. It allows you to transfer data and perform necessary actions.
Authorization is an auth behavior template for an app. Here you can set up parameters to request from a user at creating a connection, and parameters to pass in all API requests. In this section, you can also set up how to get and update access tokens.
Connection Fields that are requested from Albato end-user when creating a connection to your app. These fields are not related to authorization and can be used everywhere. For example, this could be a domain or a subdomain which users specify at their connection and this value is stored within their connection.
Triggers. Trigger is an event that happens in the sending app and starts the automation, so this is the first step of the scenario. Triggers may have two data transferring mode: wedhook and API. API calls usually executed with 1-15 min delay, and Webhook-based events always trigger instantly.
Actions is what an automation scenario performs automatically when a trigger occurs. Each completed action is considered as one Albato operation.
Lists can be dynamic (via API) or static lists, which can be linked to a specific field of an action. For example, there is a field — "Status" with stores an ID of a certain status. But statuses and IDs will be different for each user. In this case we create a dynamic list. A static list will always have a certain set of items.
Webhook catcher is an entity that is linked to Webhook triggers. It is necessary when a trigger has no set of static fields and each time you need to get different ones.
Custom field list is a list of specific custom fields sent by API. This list is attached to a trigger or an action, and an end user gets these fields..
Line section/String: A certain set of fields located in an array of trigger and actions objects ( [ { } ] ). The section itself is a single array, and fields of this section are the fields of each object of this array. By adding a string section in a trigger, you can get an entity together with attached array (e.g. goods).
Request widget is a section where users configure HTTP requests to the API, along with outgoing request, response parser and error handling. This section appears in all entities that make API requests.
Connection is an integration between Albato and your account in another app. It allows you to transfer data and perform necessary actions.
Authorization is an auth behavior template for an app. Here you can set up parameters to request from a user at creating a connection, and parameters to pass in all API requests. In this section, you can also set up how to get and update access tokens.
Connection Fields that are requested from Albato end-user when creating a connection to your app. These fields are not related to authorization and can be used everywhere. For example, this could be a domain or a subdomain which users specify at their connection and this value is stored within their connection.
Triggers. Trigger is an event that happens in the sending app and starts the automation, so this is the first step of the scenario. Triggers may have two data transferring mode: wedhook and API. API calls usually executed with 1-15 min delay, and Webhook-based events always trigger instantly.
Actions is what an automation scenario performs automatically when a trigger occurs. Each completed action is considered as one Albato operation.
Lists can be dynamic (via API) or static lists, which can be linked to a specific field of an action. For example, there is a field — "Status" with stores an ID of a certain status. But statuses and IDs will be different for each user. In this case we create a dynamic list. A static list will always have a certain set of items.
Webhook catcher is an entity that is linked to Webhook triggers. It is necessary when a trigger has no set of static fields and each time you need to get different ones.
Custom field list is a list of specific custom fields sent by API. This list is attached to a trigger or an action, and an end user gets these fields..
Line section/String: A certain set of fields located in an array of trigger and actions objects ( [ { } ] ). The section itself is a single array, and fields of this section are the fields of each object of this array. By adding a string section in a trigger, you can get an entity together with attached array (e.g. goods).
Updated on: 01/12/2022
Thank you!