Luma Automations supports integration with any third party applications that support REST APIs to execute task on the target system. The Integration enables the workflow to connect to a target system and perform a task. Here we configure the system details, authentication credentials and mechanism for the connection.
Follow the below steps to create an Integration:
Create App
To create an app:
Navigate to Integrations in the left pan.
The Connected Apps page appears as shown below. All the existing connectors are available here. These are available throughout the tenant and can be used in various workflows.
To Create a new integration, Click on Create App. The Create App page appears as shown below.
Enter the App Name. This represents the target system where you want to execute the task.
Select the Integration Type based on the type of integration supported by the target system.
Add a Description.
Click Create to complete the App creation.
The created app is now available in the Connected Apps list.
Once the Connected App is created, the next step is to create the Instance.
Create Instance
Instance represents the system environment you want to connect to. For example, For an Application (a configured target system), you may add a Trail Environment and a Production environment. Here, you may provide the Request configuration such as Global Path parameter, Global Request Header, Global Query parameter and authentication details required for Instance configuration and connecting to the target system. This are the default configurations for the instance but can be over-ridden at the Web Service Operations level.
To create an instance, follow the below steps:
On the Integrations page, select the required Application and click on Create Instance as shown below.
The Create Instance page appears.
Enter the instance Name. The next step is to define the credentials and connection details for this instance.
In Instance Configuration section, Enter the base URL to the target system environment where the the task should be executed.
The Authorization Type is used to login and perform the task. The Following are the supported authorizations types:
No Auth: Use this option, if you do not need any authentication to log in to the third-party systems.
Basic Auth: Use this option if the target system needs login credentials to authenticate and authorize the user. ‘Basic Auth’ consists of the following fields:
Username: Specify the Username used to login to the third-party system.
Password: Specify the Password used to authenticate access to the third-party system.
Bearer Token: This is the unique authentication token required for external applications to communicate with Luma Automation. Enter the unique authentication Token required for external applications to communicate with the Automation Workflow.
Global Path Parameter: The path parameter is part of a path segment that occurs after its name. Path parameters offer a unique opportunity to dynamically replace the values and pass them in the URL. Example, http://myserver.com/some-path/{parameter1}/path-continued/{parameter2}.
Enter the External Field and the Value.
Global Query Parameter: The query parameters are sometimes referred to as optional parameters. The query parameters are separated from the hierarchical parameters by the question mark. Query parameters appear in the URL after the question mark (
?
) after the resource name. Example, https://myserver.com/resource-name?param1=value1¶m2=value2.Enter the External Field and the Value.
Global Headers: Headers are mostly classified as Request Headers. You will have to set the request headers when you are sending the request.
Enter the External Field and the Value.
The following sample headers are encountered the most.Authorization: Includes credentials containing the authentication information of the client for the resource being requested.
Accept-Charset: This is a header that is set with the request and tells the server about which character sets are acceptable by the client.
Content-Type: Indicates the media type (text/HTML or text/JSON, XML/custom) of the response sent to the client by the server, this will help the client in processing the response body correctly.
Click Create to create the App Instance.
If the Instance Configuration details are overridden at the Web Service Operations level, the Global information at the Instance level are NOT affected and remain unchanged.
The first instance that you add for the Application is considered as the Default Instance. The Instance is automatically selected when the integration is selected in the workflow. You may edit the Connected App and change the Default Instance as required.