How to use IBM® App Connect with flexEngage

flexEngage is a cloud-based e-receipt solution that enables personalized transactional communications.

Availability:
  • App Connect Enterprise as a Service connector Deprecated
  • A local connector in a Designer instance of IBM App Connect in containers (Continuous Delivery release)Local connector in containers (Continuous Delivery release) 12.0.1.0-r1 or later Deprecated
  • A local connector in a Designer instance of IBM App Connect in containers (Long Term Support)Local connector in containers (Long Term Support release) Deprecated
  • A local connector in a Designer instance of IBM App Connect in containers (Support Cycle 2)Local connector in containers (Long Term Support Cycle-2 release) Deprecated

Supported product and API versions

To find out which product and API versions this connector supports, see Detailed System Requirements on the IBM Support page.

Connecting to flexEngage

  1. Click Connect
  2. Select the flexEngage environment that you want to connect to:
    flexEngage Production Environment
    flexEngage Staging Environment
  3. Complete the connection fields that you see in the App Connect Designer Catalog page or flow editor. If necessary, work with your flexEngage administrator to obtain these values.
    Client ID
    Specify the unique client identifier for flexEngage
    • Required: True
    Client secret
    Specify the application client secret for a unique application client ID
    • Required: True
    Merchant ID
    Specify the identifier of your flexEngage account
    • Required: True

    To obtain connection values for flexEngage Client ID, Client secret, and Merchant ID, see flexEngage ecommerce Platform Integration API on the flexEngage page.

  4. Click Connect

To connect to a flexEngage endpoint from the App Connect Designer Catalog page for the first time, expand flexEngage, then click Connect. For more information, see Managing accounts.

General considerations

Before you use App Connect Designer with flexEngage, take note of the following considerations:

  • (General consideration) You can see lists of the trigger events and actions that are available on the Catalog page of the App Connect Designer.

    For some applications, the events and actions in the catalog depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.

  • (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.

Events and actions

flexEngage events

These events are for changes in this application that trigger a flow to start completing the actions in the flow.

Note: Events are not available for changes in this application. You can trigger a flow in other ways, such as at a scheduled interval or at specific dates and times.

flexEngage actions

Your flow completes these actions on this application.

Order events
Retrieve order events
Create return receive order event
Create credit issue order event
Create return request order event
Create cancel order event
Create confirm order event
Create ship order event
Create pickup ready order event
Create pickup complete order event
Create pickup remind order event
Create backorder order event
Create complete order event
Create FTC delay order event

Examples

Dashboard tile for a template that uses flexEngage

Use templates to quickly create flows for flexEngage

Learn how to use App Connect templates to quickly create flows that complete actions on flexEngage. For example, open the Templates gallery, and then search for flexEngage.