"Outgoing Integration" node

This action allows you to send requests from Synerise to external systems. This node can reuse existing outgoing integrations or you can define a custom webhook that is configurable only in a specific workflow and node.

Node configuration

Select outgoing integration type

1. Click on the node.
2. Select the type of the Outgoing Integration.
   • Existing integrations - If you prepared an outgoing integration earlier, you can use this option.
     1. From the dropdown list, select the outgoing integration prepared earlier.
     2. Confirm with the Apply button.
   • Custom webhook - Use this option if you want to create outgoing integration from scratch.

Set up a connection

In this part of the process, you must define how you access your source. By selecting the authentication method and providing the required information, you establish a connection.

1. On the pop-up, select the authentication method:

• No authentication - No authentication is required.

• Login & Password - This method lets you use basic authentication to authenticate with the remote server.

  Click here to see the instructions

  1. Click Select connection.
  2. In the connection list:
     • If the connection you want to use is in the list, select it and proceed to defining the endpoint.
     • If the connection list is empty or you don’t see a connection, you must:
       1. At the bottom of the dropdown list, click Add connection.
       2. In the Connection name field, enter the name of your connection (it’s visible only on the Select connection dropdown list).
       3. In the Login field, enter a login.
       4. In the Password field, enter the password.
       5. Click Create.
          The connection you created is saved and can be used later in other nodes and workflows.

• Custom connection - This method sends an authentication token request before executing the main request defined in the Outgoing integration node settings. The token is fetched when the request data is uncached, then cached according to its TTL, and added to the target request.
  

  Click here to see the instructions

  1. Click Select connection.
  2. In the connection list:
     • If the connection you want to use is in the list, select it and proceed to Defining the request section in this article.
     • If the connection list is empty or you don’t see a connection, you must:

       1. At the bottom of the dropdown list, click Add connection.

       2. In the Authorization request tab, click Define.
          Result:

          

       3. In the Connection name field, enter the name of your connection (it’s visible only on the Select connection dropdown list or on the list of connections in Settings > Connections).

       4. In Secret, enter a value which is required in the request to obtain a token. This value will be anonymized and displayed as asterisks.

       5. In the Headers section, add request headers (in the left field, enter the key; in the right, enter its value).

       6. In the Body field, enter the request body.
          For example:

                          {
                          "api-key": "{{secret}}"
                          }
                          

          where {{secret}} retrieves the value of the Secret field to anonymize the token.

       7. Confirm the settings in the Authorization request tab by clicking Apply.

       8. In the Token placement settings section, click Define.

       9. Click Retrieve response.
          Result:

          

       10. If you:

       • specify the value in the Headers section, the extracted authorization data from the response will be added as a header to the target request.
       • provide the value in the URL Parameters section, the data will be appended to the target request’s URL as a parameter.
         You can use the following values to retrieve values from the response:
         • authResponseBody - a variable that contains the full body of an authentication response
         • authResponseStatusCode - a variable that contains the status code of an authentication response
         • authResponseHeaders- a variable that contains the headers of an authentication response
           For example:

                       Bearer {{ authResponseBody | fromjson | attr("token") }}
                       

           
           It takes the JSON response body stored in authResponseBody, parses it into a usable structure, and extracts the value of the token field. Outputs a string like: Bearer "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
       10. In TTL field, specify the how long the cached response from the external request will be valid.
           If you leave this field empty, it’s 60 seconds.
       11. Confirm by clicking Apply.

• Synerise API key - This method is particularly recommended for the users who use Synerise REST API. It lets you select a connection that includes an API key with the required permissions. This way, the requests to Synerise API are executed by this integration and a JWT is not required as it is generated while sending requests and attached to the request headers.

  Click here to see the instructions

  1. Click Select connection.
  2. If the connection you want to use is in the list, select it and proceed to defining the endpoint.
     • If the connection list is empty or you don’t see a connection, you must:
       1. At the bottom of the dropdown list, click Add connection.
       2. In the Connection name field, enter the name of your connection (it’s visible only on the Select connection dropdown list).
       3. From API Key dropdown, select API key you want to use. If you don’t see any API Keys on the list, verify if you are assigned with a user role that includes permissions to preview API keys.
       4. Click Create.
          The connection you created can be used later in other nodes and workflows.

• OAuth2 Client Credentials - This method lets you use your OAuth2 credentials to authorize.

  Click here to see the instructions

  1. Click Select connection.
  2. In the connection list:
     • If the connection you want to use is in the list, select it and proceed to defining the endpoint.
     • If the connection list is empty or you don’t see a connection, you must:
       1. At the bottom of the dropdown list, click Add connection.
       2. In the Connection name field, enter the name of your connection (it’s visible only on the Select connection dropdown list).
       3. In the Token endpoint URL field, enter the URL used to obtain an access token from the authorization server.
       4. In the Client ID field, enter a unique identifier assigned to your application by the service provider.
       5. In the Client secret field, enter a confidential key issued alongside the Client ID. It is used to securely authenticate your application.
       6. Optionally, in the Scope field, define the level of access your application is requesting. Scopes specify which actions or data your application can access (for example, read user data, send messages). Refer to the API documentation for the correct scope values.
       7. Click Create.
          The connection you created is saved and can be used later in other nodes and workflows.

• API Key - This method lets you authenticate using an API secret by including it in a header of your choice or in a URL parameter — example outputs:

  • the authorization header: Authorization: Bearer [secret]
  • URL parameter: client_id=[rendered secret].
    When you use this connection in the Outgoing Integration node, the token will be automatically added to either the request header or the request URL with every request.
  Click here to see the instructions

  1. Click Select connection.
  2. If the connection you want to use is in the list, select it and proceed to Defining the request section in this article.
     • If the connection list is empty or you don’t see a connection, you must:
       1. At the bottom of the dropdown list, click Add connection.
       2. In the Connection name field, enter the name of your connection (it’s visible only on the Select connection dropdown list).
       3. In the Secret field, enter an API Key.
       4. If you:
          • specify the value in the Headers section, the API key will be added as a header to the request. For example, x-api-key: {{secret}} where {{secret}} retrieves the value of the Secret field to anonymize the API key value.
          • provide the value in the URL Parameters section, the API key will be appended to the request’s URL as a parameter.
       5. Click Create.
          The connection you created can be used later in other nodes and workflows.

• SHA256-based authentication - This method is recommended exclusively for connecting with Eagle Eye. This method lets you authenticate using the SHA256 algorithm. When a target request is sent, the following headers are added to the request:

  • X-EES-AUTH-CLIENT-ID – the value is taken from the Client ID field.
  • X-EES-AUTH-HASH – the value is generated by concatenating the endpoint URI, request body, and client secret, and then hashing the result using SHA256.
  Click here to see the instructions

  1. Click Select connection.
  2. In the connection list:
     • If the connection you want to use is in the list, select it and proceed to Defining the endpoint section in this article.
     • If the connection list is empty or you don’t see a connection, you must:
       1. In the Connection name field, enter the name of the connection.
          It’s used to find the connection on the list.
       2. In Client ID, enter a unique identifier assigned to your application by the service provider.
       3. In Client secret, enter client secret assigned to your application by the service provider.
       4. Confirm by clicking Create.

Define the endpoint

Note: All fields that contain accept snippets or inserts. If you create a business workflow, profile-related inserts cannot be used.

1. In the Webhook name field, enter the value that will be displayed in the name parameter of the event which will be generated when a request from this node will be executed.
2. Optional, recommended: In the Event name field, choose an action name for the event that will be generated when Synerise receives a response from your selected endpoint. We recommend using a meaningful name instead of the default one.
   • from the dropdown list, you can select the name of the event (event action) that will be generated when a request from this node will be executed.
   • at the bottom of the dropdown list, you can create a new event using the Create new event option.
     Result: A pop-up appears. Fill out the configuration form on the pop-up, according to instructions in step 3 in the Adding event definitions - in the Web application section.
   • If you leave the field blank, the action defaults to webhook.response.
3. In the URL section, define the HTTP method and enter the URL address to which the data is transmitted.
   WARNING: This field requires a defined domain (for example, https://example.com) and the HTTPS protocol. You can’t use an IP (for example, 192.0.2.0) or use Jinjava for defining the domain as a dynamic value.
4. Optional: Add key-value pairs for headers.
5. Optional: In the Body section, enter the body of the request.

Custom response event parameters

You can add up to 10 custom parameters in each event that is generated from the response to the request that was sent. This solution allows for even more precise identification of response events, the creation of more detailed analyses and reports, and more accurate error handling.

1. To define the custom event parameters, in the Additional event parameters section, click Add parameter.

2. In the Parameter field, enter the name of the parameter.

   • The name must not contain special characters or exceed 128 characters
   • The following parameters cannot be sent:
     • eventUUID
     • status
     • statusDescription
     • uuid
     • clientId
     • diagramId
     • diagramName
     • blockId
     • blockName
     • req
     • name
     • body

3. In the Value field, enter the parameter value.

   • The value is always sent as a string when the event’s JSON payload is generated. The maximum length of the value is 230 characters.
   • You can use dynamic values in the Value field.

4. If you want to add more parameters, click Add parameter, and repeat steps 3-4.

5. After finishing the configuration of the node, at the bottom of the pop-up, click Apply.

Example of use

The purpose of this automation is to send a notification on a Slack channel every time a user submits a form on a website.

1. It starts with a Profile Event trigger node. In the settings of the trigger, select the form.submit event. This event may not be the Synerise default event. In such case, you need to add this event to Synerise on your own in Data Management > Events.
2. Add the Outgoing Integration action. Configure the Webhook settings by defining the Endpoint URL, body request, and so on.
3. When the message is sent to the Slack channel, the automation process is completed.