Versions Compared

Version Old Version 2 New Version 3
Changes made by

John Kargol

John Kargol

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The “Integration” panel is a quick, easy way to connect to 3rd party systems within your Logic+ flow. This panel executes a defined request to a configured generic integration and is useful to push or pull data between Sharpen and an available RESTful API.

Prerequisites

  1. Configure one or more desired integrations using the Integrations page. These entries record an API's base URL, protocol (REST or SOAP), and authorization details. The Integration panel uses these records to build the API requests it makes.

    1. In Admin view, go to Configuration → Integrations. The Integrations page will be displayed.

    2. Select Add Integration, then Add in the following window. Complete the form fields, then select Save Integration. Your integration will now be displayed in the grid on the Integrations page.

    3. Make note of the integration's name for later use.

Image Added

Using the panel

Incorporating relevant third-party services and systems in your Logic flow is possible through this panel. This includes many that are publicly available, or privately-operated ones that your company may control.

For example, you may want a Logic flow to interact with a company database containing customer account information. Creating an entry in the Integrations page, then configuring the necessary request with the Integrations panel, allows your Logic to perform this task.

Configuration

The following fields are available:

  1. Panel Name: Enter a unique name to identify the panel.

  2. Set as Flow Initiator: Select this button to set the panel as the starting point (i.e., the flow initiator) of the Logic flow. Once set, this can only be removed by setting a different panel as the flow initiator.

  3. Panel Description: Enter notes about the panel for reference here. This field is collapsed by default. Select the arrow to expand and collapse it.

  4. Test Panel: Make test calls to your integration and view responses. Test calls will be configured automatically as you configure this panel. Select Test at any time to make an API request using the panel's current configuration. The response code and response body will be returned in this panel. Useful for troubleshooting your requests while configuring this panel.

    1. Response code: Displays the HTTP response code returned for your request.

    2. View/Hide Response: Displays the response body returned for your request in a collapsible field. Selecting a property value in this response body will automatically create a variable in the Variables section to store it. This variable can be called for use in the following panels.

  5. Integration: Choose an integration to call by either using the dropdown menu (default) or entering a variable:

    1. Use Dropdown: Select an integration from the dropdown menu. All integrations created within your company's Sharpen account will appear here.

    2. Use Variable: Enter a variable that contains an integration's ID. See the Prerequisites section above for details on finding this ID.

  6. Path: Enter the path of the API endpoint to be used. This path will be appended to the base URL used in your selected integration. Leave empty if your integration's base URL is the only endpoint.

  7. Method: Select an HTTP request method from the dropdown menu. Options include GET (default), POST, PUT, DELETE, and PATCH.

  8. Headers: Enter any request headers needed (e.g., content type, authorization) for your integration.

  9. Request Body: If using the POST, PUT, or PATCH methods, enter the request body as a JSON string.

  10. Content Type: Select a content type to add as a request header. Options include JSON and form data.

  11. Timeout: Specify the number of seconds to wait for a response from the integration endpoint. The default value is 1 second. Acceptable values range from 0 to 60.

  12. Variables: Store the API request's response data by creating a variable. Select the plus sign (+) by Add New to add a new line entry for a variable. Each entry defines a variable by name and JSON path. See Additional Information at the bottom of the page for more information.

    1. Name: Enter a unique variable name.

    2. Jsonpath: Enter the JSON path to the desired data in the response body (e.g., $.results[0].firstName). Stores the entire response body by default if this field is left empty.

  13. Fire & Forget: Specify whether this panel should wait for a response from the integration's endpoint before proceeding through an output path. If set to wait, the panel will wait up to the number of seconds specified in Timeout. Options are to use either a toggle (default) or a variable.

    1. Use Toggle: If switched off (default), the panel will wait. If switched on, the panel will immediately proceed to the appropriate exit path.

    2. Use Variable: Enter a variable that contains a value for Boolean evaluation. The values "true" and "1" will evaluate to true, which causes the panel to immediately proceed to an appropriate exit path. All other values evaluate to false, which causes the panel to wait.

  14. Exit Paths: Use the dropdown menu to select another panel in your flow. Any output from this panel will advance to the linked panel.

Additional Information:

  • Automatically creating variables to store response data. In the Test Panel, if you select Test, then select a property value in the response body, this panel will automatically create a variable that stores that value. You can create variables for the response data you need this way, selecting them from the Test Panel instead of configuring them by hand.

  • Entering headers and the request body. The code entry fields for request headers and body (see # and # in the Configuration section below) will automatically flag issues with your request syntax line-by-line. This feature is for assistance only and does not guarantee that your entries will be error-free.