Documentation
API Documentation
API Documentation
  • Introduction
  • EXECUTE FLOW API
    • Overview
    • GraphQL executor
      • Schema
    • Execute Flow Parameters
    • Integrating with Third-Party Applications
      • Amazon Connect Configuration
      • Execution Flow Process
Powered by GitBook
On this page
  1. EXECUTE FLOW API
  2. Integrating with Third-Party Applications

Amazon Connect Configuration

Last updated 1 year ago

The Amazon Connect Configuration involves a series of steps to set up and customize the contact flows and interactions within Amazon Connect, ensuring integration with the Execute Flow API.

Here's a breakdown of the key components:

  1. Create Call Flows

    Establish call flows within Amazon Connect to precisely define how calls are handled and managed.

  2. Set Up Branching Conditions Configure branching conditions within the call flows, allowing dynamic responses based on user input during interactions.

  3. Configure Parameters and Attributes Configure necessary parameters and attributes within the Amazon Connect contact flow. This critical step ensures that the flow captures and processes essential information during interactions.

    • Flow ID: Utilize the unique identifier of the flow to be executed, easily accessible in the flow properties within the CXF application.

    • Tenant ID: Employ the identifier of the tenant or customer company registered in CXF, conveniently obtained from the company overview page within the CXF application.

  4. Implement Lambda Function Develop a Lambda function (e.g., CXF test) that acts as a bridge to the Execute Flow API. This function will be responsible for invoking the executeflow API with the required payload, facilitating the execution of specific workflows. The Lambda function can be customized based on specific requirements, such as the information or values to be passed. In the CXF test Lambda example, it focuses on obtaining the tenant ID, flow ID, and record type. It is also essential to specify certain parameters to ensure proper functionality. These parameters include:

    • Endpoint URL: The executor URL where incoming webhook requests will be sent.

    • Security Token: An optional token used for authentication and ensuring the integrity of webhook requests.

    • Payload : A JSON object containing information relevant to the specific workflow being triggered. The structure of this object may vary based on the workflow. (In the screenshot the payload starts at line 27).

  5. Connect Lambda Function to Contact Flow Establish a connection between the Lambda function and the Amazon Connect contact flow. This integration ensures that the Lambda function is seamlessly invoked during the call flow, enabling the execution of desired actions based on user input.

By following these steps, the Amazon Connect Configuration ensures a tailored and effective integration, providing a foundation for executing workflows triggered by the Execute Flow API within the Amazon Connect environment.

Inbound Flow Branching Conditions
Contact Attributes
CXF Test Lambda Function
Lambda Function in the Contact Flow