Skip to main content

Custom apps

Custom apps let you define an app connection for an API by configuring its information, authentication, outgoing request, parameters, and incoming response.

Create a custom app​

  1. Open Apps and select Add app.
  2. Select Custom integration.
  3. Configure the app using the sections in the left navigation:
    • Information
    • Authentication
    • Outgoing request
    • Parameters
    • Incoming response
    • Overview
  4. Select Save when the configuration is complete.

Configure app information​

In Information, enter the general information for the app.

App name and variable structure​

Enter an App name. Configure the app variable and method fields. The editor displays the resulting variable token beside the structure.

App and API versions​

In App Version & API Version, enter the App Version and API Version values.

App icon​

In App icon, configure the app appearance with:

  • Background color
  • Text color
  • Icon

You can also select an image with Select Image.

Configure authentication​

In Authentication, select the authentication type and complete the fields shown for that type. The available types are:

RequestUsage
No AuthIf you don’t need to certificate who is asking for the resource
Basic AuthWith username and password
OAuth1.0This is a deprecated authentication method but, some APIs are still using it. We need to specify the Consumer Key (API Key), Consumer Secret (API Secret), Access Token and Access Token Secret
OAuth2.0The last and secure version of this kind of authorisation used from the most common APIs. We need to specify the Auth URL to send the request, Access Token URL, Client ID, Client Secret, the Scope in case we need it, choose the Grant Type and type the Access Token and the Access Token Structure
App AuthThis method allows you to select the authentication of another custom app

Depending on the selected type, the form can include authentication and token URLs, redirect or callback URLs, client credentials, scopes, grant type, access-token settings, and refresh-token settings. App Auth lets you select a custom app.

warning

When authentication information is changed, it will be copied to all the flows which have this App.

Configure the outgoing request​

In Outgoing request, define the request sent to the API.

Select a request format​

Select the format that matches the API:

  • JSON — for RESTful APIs.
  • XML — for APIs that use XML.
  • URL — when information is sent in a URL.
  • SOAP — for SOAP APIs.
  • RAW — when using an unstructured payload.

Import a cURL request​

Turn on the option, paste the cURL command, and select Import. Importing a cURL command replaces the previous outgoing-request configuration.

Configure the URL and method​

Enter the destination in URL, then select an HTTP method. The available methods are POST, GET, PATCH, PUT, OPTIONS, HEAD, and DELETE.

Add headers​

Turn on Headers, select + New header, and enter the header key and value.

If you switch Headers to No, confirm whether to delete all headers.

warning

Deleting the headers cannot be undone.

Add a payload​

Turn on Payload to define the data sent to the URL. Enter the request in Paste here your payload and review the result after variables are applied.

The editor can detect possible parameters in the payload and show Review parameters. Select Hide parameters to close the review area.

Add request parameters​

In Parameters, select + Add new parameter to define values that can be supplied to the outgoing request. The parameter list shows the Label, Type, Required, and Show status.

In the New Parameter dialog, configure:

  • Label of the Parameter: The name of the parameter that will be displayed in the editor.
  • Name of the Parameter: It must be unique within the app.
  • Is required: If the field will be mandatory or not
  • Type of Parameter: Type of input field.
  • Help text configuration: If you want to add help text to the parameter.

When help text is enabled, enter the text that should explain the parameter. Select Save to add it to the list.

Parameter references use the @object.params. prefix and an @ suffix. For example:

@object.params.new_parameter_0@

A default value can be set for the parameter if you fill the parameter value.

Test the request​

Select Save and Test in Parameters to open Test parameters.

Select Save response variables to save response information, or Close to return to the editor.

Configure the incoming response​

In Incoming response, define how the app reads the response returned by the request.

Select a response format​

Select the response format:

  • JSON
  • XML
  • SOAP
  • RAW

Add response parameters​

Select Get from last test response to retrieve parameters from the most recent test response. You can also add them manually with:

  • + Add Header parameter
  • + Add Body parameter

The response-parameter tables show where each parameter is saved. Body parameters also show whether they are saved in the Data Schema.

Review and save​

Open Overview to review the app, including its version information and outgoing-request configuration.

Click Save to confirm the changes.

Was this article helpful?