1. Home
  2. Integrations
  3. Quick Guide - Creating an Integration

Quick Guide - Creating an Integration

See how to create an integration from start to finish

Check out this quick guide and create an integration flow from start to finish:

Create authorizations

Click on the Authorizations card.

Click on + AUTHORIZATIONS.

Choose the authorization type.

Fill in the form.

Click on SAVE.

Creating an authorization Creating an authorization

NOTE

Learn more about creating and configuring authorizations in Authorizations.

Create an integration flow

Click on the Integration Flows card.

Click on + NEW FLOW.

NOTE

The canvas is locked when opened. To unlock it, enter a unique name and version for the integration flow.

Click on SAVE.

Creating an integration flow

Register environment variables

Click on the Environment Variables button, in the editing menu on the left.

Fill in the Name and Description fields in the INFORMATION section.

Click on + ADD A NEW VARIABLE, in the ROOT section.

Fill in the registration fields:

  • Type: select the variable type.
  • Variable: enter the variable name. It is not allowed to register the same variable more than once.
  • Value: enter the variable value.

Click on SAVE.

Configuring environment variables

NOTE

Learn more about creating and configuring Environment Variables.

Add and configure steps on the canvas

By default, you will see the Start Start and End End steps on the canvas. They mark the beginning and end of the integration flow, in that order.

Triggers

To start the integration flow, add a trigger type step.

Click on the Triggers icon, in the editing menu on the left.

Select a trigger.

The Start Start is replaced by the trigger as soon as you add it to the canvas.

Fill in the form.

Click on SAVE.

NOTE

The trigger allows only one connection to the subsequent step.

Configuring a Scheduler Trigger

NOTE

Learn more about configuring Triggers.

Connectors

Next, add connector type steps to the integration flow.

Click on the Connectors icon, in the editing menu on the left.

Select a connector.

NOTE

Each connector allows only one connection to the previous step and one connection to the subsequent step.

Configure the connector.

Click on SAVE.

TIP

After configuring and connecting the steps, the Alert icon will disappear.

Configuring a connector

NOTE

Learn more about configuring Connectors.

General Tools

The General Tools perform operations with data within the integration flow.

TIP

This step is not mandatory.

Click on the General Tools icon, in the editing menu on the left.

Select a tool.

Fill in the form.

Click on SAVE.

Configuring the For Each tool

NOTE

Learn more about the different General Tools and their configurations.

Save the integration flow and run it in Test Mode

After saving your flow, run a test to check for any errors before deploying.

Click on the TEST MODE button, in the upper right corner of the canvas.

If you used the Rest Trigger in your flow, define the execution payload in the Body field and enter the values for Headers and Query Params.

Click on the EXECUTE button to run your integration flow.

Check the execution information in the Execution Info section.

Click on View Log View Log to check the detailed execution logs.

Testing your integration flow

NOTE

Learn more about the integration flow Test Mode.

Deploy the integration flow

Click on the DEPLOY button in the upper right corner of the canvas.

Fill in the fields:

  • Description (optional): the deployment description.
  • Environment: selection field to choose the deployment environment. You must choose between:
    • Staging: testing environment. It is enabled by default.
    • Production: production environment.
  • Value (optional): the value of the environment variable registered in the flow. Editable field.
NOTE

The other fields are read-only.

Click on DEPLOY in the lower right corner to deploy your flow.

Deploying your integration flow

NOTE

Learn more about the integration flow Deploy.

How happy are you with this page?

We use cookies to enhance your experience on our site. By continuing to browse, you agree to our use of cookies.Learn more