Skip to main content

Connect with API

Isabel Mariz avatar
Written by Isabel Mariz
Updated over 2 months ago

For more custom integrations within Automations, you can establish connections directly via API, allowing you to connect with virtually any service that offers an API. This connection enables your automation to send requests and interact with external APIs according to your configuration.


Set up an API connection

  1. Go to the BindTuning App.

  2. Navigate to Automate365 > Connections.

  3. Click the "Create connection +" button, and select "API Request".

  4. A pop-up will open to configure the API connection.


API authentication options

Below, you'll find an explanation of the different API authentication options and the required parameters for each.

Basic Authentication

Uses a simple username and password for access.

Parameter

Description

Connection Name

A label to identify your connection

Username

Your API username or client ID

Password

Your API password or client secret

Bearer Token

Authenticates requests using a secure, typically time-limited, access token.

Parameter

Description

Connection Name

A label to identify your connection

Bearer Token

The token string used in the Authorization header for authentication

API Token

Uses a unique, secret key to verify and authorize API requests.

Parameter

Description

Connection Name

A label to identify your connection

API Token

The token string used for authentication

Parameter Name

The name of the parameter to pass the token

Parameter Type

Specifies whether the token is sent in the Authorization header or as a query parameter

Important note on API Responses

To ensure proper processing within the automation, the response object returned by your API must be a single-level JSON object (i.e., no nested objects or arrays). This restriction helps the system correctly map and handle the data for further steps.

About connection failure

Unlike other connection types, API request connections are not automatically validated. If you change your API endpoint, credentials, or tokens, you must manually update the connection settings in Automate365.

Failure to update these details will cause automation failures. The system will notify you if an automation attempt fails due to invalid connection details, allowing for timely troubleshooting.


Once you've configured the connection, simply check your connections list to confirm its status is "Connected."

Note: For other types of connections, refer to the full list of connection types.

Did this answer your question?