Integration Panel

Overview

The Integration panel connects your Logic+ flow to third-party systems by executing a defined request to a configured integration. It is useful for pushing or pulling data between Sharpen and any available RESTful API, allowing your flow to interact with external databases, services, and platforms in real time.

Prerequisites

Before using this panel, you must configure at least one integration on the Integrations page. Each integration entry records the API's base URL, protocol (REST), and authorization details. The Integration panel uses these records to build its API requests.

For setup instructions, see Initial Integration Setup.

Before You Begin

This panel supports connections to many publicly available services as well as privately operated systems your company controls. A common use case is querying an internal customer database, by creating an integration entry and configuring the appropriate request, your Logic flow can look up account details, retrieve order history, or pass data to an external system automatically.

Example Use Case

A Logic+ flow handles inbound calls from customers inquiring about their accounts. When the caller enters their account number, the Integration panel sends a GET request to the company's internal CRM API, retrieves the customer's name and account status, and stores those values as variables. Subsequent panels then use those variables to personalize the interaction and route the call appropriately.

Properties

• Name

  • Enter a unique, descriptive name to identify the panel.

• Description

  • Enter any notes about the panel for reference. This field is collapsed by default; select the down arrow to expand it.

• Initiates Flow

  • Designates this panel as the starting point of the Logic flow. When selected, this panel will be the first to execute when the flow is triggered. This can only be removed by setting a different panel as the flow initiator.

• Redact Data in Logging

  • Disables data logging for this panel to support data redaction requirements. This feature is available upon request and is subject to change.

Test

The Test Button lets you make live API calls using the panel's current configuration and review the response without leaving the editor. This is useful for verifying your request setup and troubleshooting before the flow goes live.

Click Test at any time to send a request using the current configuration. The following will be returned:

• Response Code: The HTTP status code returned by the API (e.g., 200, 404, 500).

• Response Body: The full response payload, displayed in a collapsible field. Selecting a property value directly in the response body will automatically create a variable in the Variables section to store that value, saving you from configuring it by hand.

Fields

• Integration

  • Select the integration this panel should call.

    • Use Dropdown: Select from all integrations configured in your company's Sharpen account.

  • Use Variable: Reference a variable containing an integration's ID.

• Path

  • Enter the API endpoint path to append to the base URL defined in your selected integration. Leave this field empty if the integration's base URL is the only endpoint needed.

• Method

  • Select the HTTP request method to use. Available options are GET (default), POST, PUT, DELETE, and PATCH.

• Headers

  • Enter any request headers required by your integration, such as content type or additional authorization details.

• Request Body

  • If using the POST, PUT, or PATCH methods, enter the request body as a JSON string.

• Content Type

  • Select the content type to include as a request header. Options are JSON and Form Data.

• Timeout

  • Specify the number of seconds to wait for a response from the API endpoint before the panel moves on. The default is 1 second. Acceptable values range from 0 to 60 seconds.

Variables

Define variables to store data returned in the API response. Select the + Add icon next to Variables to add an entry. Each entry consists of:

• Name

  • Enter a unique name for the variable. This variable can be referenced in subsequent panels throughout the flow.

• JSON Path

  • Enter the JSON path to the specific value you want to capture from the response body (e.g., $.results[0].firstName). If left empty, the entire response body will be stored in the variable.

Fire & Forget

Determines whether this panel waits for a response from the API before proceeding to the next panel in the flow. If set to wait, the panel will hold for up to the duration specified in Timeout.

• Off (default): The panel waits for the API response before proceeding.

• On: The panel immediately proceeds to the appropriate exit path without waiting for a response.

• Use Variable: Reference a variable for dynamic control. The values true and 1 evaluate to on (proceed immediately); all other values evaluate to off (wait for response).

Exits

• Default

  • The path taken upon successful panel execution.

• Timeout

  • The logic executed when the API endpoint does not respond within the configured timeout period.

• Error

  • The path taken if an error occurs during the API request.

Related Articles

• Configuring Integrations for Logic+

• Generic Integrations