Add a bridge action for connectors


Note: This article applies to the web services data dip connector.

After you add and start a web services data dip connector, you can create or update an interaction flow in Architect that uses a bridge action associated with the connector. For more information, see Add a data dip connector.

Bridge actions are associated with either a default connector action or a custom connector action. Use a default connector action to retrieve information about accounts, cases, or contacts. Use a custom connector action to interact with information by selecting CustomAction, configuring the endpoint, and adding request and response schemas.

  1. Add a bridge action to a connector group.
    1. In Genesys Cloud, click Admin.
    2. Under Integrations, click Bridge.

      The Manage Bridge Integrations page appears.

    3. Click the Actions tab.
    4. Click Add Action.

    The Add a New Bridge Action dialog box appears.

  2. Select a connector group and a connector action.

    In the Add a New Bridge Action dialog box, follow these steps:

    1. Under Select Connector Group, select the name of the web services data dip connector that you added.

      This list of connector groups matches the names of your connectors on the Connectors tab of the Manage Bridge Integrations page. Selecting a connector group in this list associates a connector action with your connector. 

    2. Under Select Connector Action, select a default or custom connector action that you want the connector group to use.

      A default connector action retrieves information about accounts, cases, or contacts from a third-party system by using a web service. A custom connector action allows you to create request and response schemas to interact with information in a third-party system by using a web service.

      The example uses the default connector action GetAccountByPhoneNumber.

    3. Click Next.
  3. Identify the bridge action.
    1. Enter the following information:
      • Name: A name for your action.

        Names cannot include spaces or special characters but can include hyphens and underscores. 

      • Description (optional): A description for the action. 
      • Category (optional): The category name for the action.

        A category is a name for a group of related bridge actions. When you are creating a call flow in Architect, categories can help you find a bridge action that is part of a particular group.

      • Help Link (optional): A link to internal support documentation about the bridge action.
      • Suggested Timeout (ms) (optional): Time after which action times out.

        Leave this box blank for the default timeout of 5 seconds (= 5000 ms).

    2. Select Flatten metadata.

      If you do not select Flatten metadata, Architect cannot use the bridge action.

    3. Click Save.

    The Action Details page for the bridge action that you saved appears.

  4. Modify the request and response schemas (custom connector action only).

    For bridge actions that use the custom connector action, modify the default request and response schemas. The schemas allow you to specify the information that you want to request and receive from your web service. 

    Key Value
    $schema Do not change. Default: “http://json-schema.org/draft-04/schema#”.
    title Schema title.
    description Schema description.
    type Do not change. Default: “object”.
    properties

    The names of the objects of the properties (Code in the example Request Schema) appear under Inputs in your call flow in Architect.

    Warning: Do not use nested objects; schemas with nested objects do not flatten correctly.

    {object} Property object.
    type Object type. Supports all JSON types, except object, null, and nested arrays.
    description Object description.
    additionalProperties Do not change. Default: true.
    Note: The connector only works with valid JSON schemas and does not validate the request and response bodies against the schemas. 

    The following are example schemas that check if a code, or string of characters, is the winning code in a contest. 

    Request schema

    {
       "$schema": "http://json-schema.org/draft-04/schema#",
       "title": "Code Request Schema",
       "description": "Schema to send a code for evaluation",
       "type": "object",
       "properties": {
          "Code": {
             "type": "string",
             "description": "Your entry code"
          }
       },
       "additionalProperties": true
    }
    

    Response schema

    {
       "$schema": "http://json-schema.org/draft-04/schema#",
       "title": "Code Status Response Schema",
       "description": "The schema for the results of the code evaluation",
       "type": "object",
       "properties": {
          "status": {
             "type": "string",
             "description": "The status of your code"
          },
          "prize": {
             "type": "string",
             "description": "The prize won, if any"
             }
          },
         "additionalProperties": true
    }
    

    After you modify the default request and response schemas, check whether your schemas flatten correctly. Click the preview button (eye icon) next to Flatten metadata. 

    Preview flattened metadata icon

  5. Add configuration properties (custom connector action only).
    1. Click the Configuration tab on the Action Details page.
    2. Add a value for Endpoint.

      This value is the endpoint for your web service that you want the schemas to use.

      • If you add an absolute URL that begins with http:// or https://, the connector uses this full URL as the endpoint.
      • If you add a relative path, the connector adds Endpoint to EndpointAddress in the connector configuration.

      For example, if you input /custom for Endpoint for the action and https://www.acme.com/ for EndpointAddress in the connector configuration, the connector uses https://www.acme.com/custom as the endpoint.

    3. Click Save.
  6. Publish the bridge action.

    To use the action in Architect, click Publish at the bottom of the Action Details page.

    Note: Once you click Publish, you can no longer modify the bridge action. Instead, you must delete the bridge action and add a bridge action by following the steps in this article. If you use the deleted bridge action in a call flow, you must update the call flow in Architect to use the new bridge action. For more information, see Use bridge actions.

    Click image to enlarge.

    Action Details page for the web services data dip connector

The bridge action is now associated with your connector and ready for use in Architect.

Next, use the bridge action in Architect.

For more information about the connector, see About the web services data dip connector.