Skip to main content

HTTP

The HTTP connection in linqi allows you to connect generic web services. It is therefore one of the most flexible ways to connect third-party systems, but also requires the most technical knowledge.

info

To be able to use the HTTP connection, you must activate the corresponding feature in the business unit administration.

Connection​

In order to be able to communicate with third-party systems via the HTTP actions in linqi, you must first create a corresponding connection in the connection management ( button in the navigation).
In the connection list, you can use the plus button on the top right-hand side and then select HTTP connection. You have the following options in the connection settings:

  • Display name:
    The display name helps you to reuse the connection and can be freely assigned.
  • Type of connection:
    Here you can determine which type of authentication is used. The following options are available here:
    • Anonymous:
      No authentication is carried out. However, this can be useful, for example, if an API key is sent via an HTTP header.
    • Basic:
      Basic Authentication is performed with user name and password.
    • Windows:
      NTLM or Kerberos, if available, is used with Windows user name and password.
  • User name:
    If you are using a connection type that requires a user name, you must enter the user name here (including domain in the case of Windows).
  • Password:
    If you are using a connection type that requires a password, you must enter the password here. This cannot be requested again afterwards.
  • Authorized persons:
    Here you can restrict which persons can use this connection in the process designer, details can be found here.

Actions​

HTTP request​

You can use this action to send HTTP requests to web services in order to send or load data. The following configuration options are available:

  • Connection:
    Select the connection (see above) here which is used to log in to the web service.
  • Url:
    Here you can specify the url which is requested.
  • Method:
    Select the HTTP request method which will be used. If you use a method other than GET, you can define the following formats:
    • Text:
      Use this format to send JSON or XML to a web service, for example.
    • File:
      You can use this format to send files to the web service.
    • Multipart:
      If you select this format, you can send both text and files as one request to a web service. For example, you can send a file with metadata.
  • Header:
    Here you can insert headers to transmit e.g. an API key, content type etc.
  • Format of the receiving data:
    If you want to load data from a web service and reference it via a placeholder, you can define here whether you expect a response in JSON or file format. You can make the following configurations:
    • JSON schema:
      If you expect a JSON response, you can specify a JSON schema here. The response is validated against this JSON schema and the defined properties can be referenced as placeholders after you have saved the process. Filename:
      Define the file name to be used for the downloaded file.
  • Enable error output:
    Once you enable this switch, you can Intercept and process errors.

HTTP webhook​

This action can be used as a process start, e.g. to automatically start a process when something happens in a third-party system. The following configuration options are available:

  • Webhook URL:
    The URL to which you must send a request in order to trigger the webhook is displayed here.
  • User context:
    Enter the person for whom a process is being started here. You can of course then adjust the authorizations directly via the corresponding actions.
  • Format of the data received:
    If you expect the webhook to send data to linqi and you want to reference the data via a placeholder, you can define here in which format the data is expected. You can make the following configurations:
    • JSON schema:
      If you are expecting a JSON request, you can specify a JSON schema here. The request is validated against this JSON schema and the defined properties can be referenced as placeholders after you have saved the process.
    • Filename:
      Define the file name to be used for the received file. If you do not specify a file name, the file name of the received file is used.