Integrations allow applications  to integrate with 3rd party services. Integrations are first created at an organization level and are then made available for use within applications.

To create an integration, from the My Apps page, go to the left menu, Develop > Components, then select Integrations. 

✰Note: Integrations must first be created under Components before they can be added to applications.

Integrations

Click > Add Integration

Add New Integration

Description of fields:

Fields
Description
Name*
Enter the name of the function.
Type
Only Custom type is available at this time.
Account
Choose an account:
-Google Service Account
-Simple Credentials
-SSH Public Key Credentials
Description
Describe this function.

There are three navigation tools under Integration:

  1. Functions
  2. Parameters
  3. Developers

Functions

To add a function Click > New Function

Add New Function

Description of fields:

Fields
Description
Name
Enter the name to be given to the function.
Returns Type
Choose the return type:
-String
-Integer
-Float
-Boolean
-Void
-Object
-Array
Private
A private function is only for developers and not for end users.
Arguments
Define the arguments of the function. Arguments can be:
-String
-Integer
-Float
-Array
-Boolean
-Object
Script
Enter the script that should be executed when this integration is used.

Parameter

Parameters are useful when an app is meant for use by multiple organizations. They are app-level configurations that are set on a per-tenant basis so that different organizations can customize an application. 

Parameters are defined by app developers and can be optional or required fields. When parameters are required, an app cannot be used until they are properly configured. 

To add a new parameter Click > Add Parameter

Add New Parameter

Description of fields:

Fields
Description
Name
Enter the name to be given to the parameter.
Label
Enter the name of the label.
Default Value
Enter default value.
Description
Enter the description value.
Type
Enter the String type.
SubType
Enter the Sub type:
-Plain
-Email
-Password
-URL
Required
Enable this setting if the integration parameter is required.

Once an integration is created, it can be used by applications within that organization. Within an app, go to Integrations from the left menu.

Active Integration Module

Here you will see integrations that have previously been created and are available for use. Each application will have its own functions and parameters, depending on how it was configured at creation.

Developers

Developer section displays the list of users that can work on developing integrations. Developer can be added only after creating an Integration.

Add New Developer

To add a developer Click > Add Developer

Add New User

Select the user from the drop down list to be assigned to work on the integration.





Up Next

No Topics.