Requirements for the data actions integration

Note: This article applies to the AWS Lambda, Function, Genesys Cloud, Google, Microsoft Dynamics 365, Salesforce, web services, and Zendesk data actions integrations.

This article lists all third-party and Genesys Cloud requirements to run a data actions integration.

AWS account

  • An AWS Lambda function with the following characteristics:
    • That supports JSON-based inputs and outputs.
    • That executes in under 20 seconds.
  • An IAM role that has access to one or more AWS policies or AWS Lambda functions. For more information, see Create IAM resources to invoke AWS Lambda functions. 

Genesys Cloud

  • A Genesys Cloud organization.
  • The following permissions (at a minimum) selected for the administrator of the integration and actions:
    Notes:
    • Depending on where you access the permissions in Genesys Cloud, the permission names appear in different formats.
    • Instead of selecting individual Integrations > Action permissions, you can select Integrations > Action > All Permissions. This permission grants administrators access to all current and future permissions associated with actions.
    • Integrations > Integration > Edit and View

      These permissions allow administrators to edit and view integrations.

    • Integrations > Action > Add, Delete, Edit, Execute, and View
      These permissions allow administrators to add, delete, edit, test, and view custom actions.
  • One or more installed AWS Lambda data action integrations. For more information, see Add a data actions integration.
  • An IAM role added to the integration credentials in Genesys Cloud.

For more information about the integration, see About the AWS Lambda data actions integration.

Genesys Cloud

  • A Genesys Cloud organization with Genesys Cloud CX 1, Genesys Cloud CX 2 or Genesys Cloud CX 3 license.
  • The following permissions (at a minimum) selected for the administrator of the integration and actions:
    Notes:
    • Depending on where you access the permissions in Genesys Cloud, the permission names appear in different formats.
    • Instead of selecting individual Integrations > Action permissions, you can select Integrations > Action > All Permissions. This permission grants administrators access to all current and future permissions associated with actions.
    • Integrations > Integration > Edit and View

      These permissions allow administrators to edit and view integrations.

    • Integrations > Action > Add, Delete, Edit, Execute, and View

      These permissions allow administrators to add, delete, edit, test, and view custom actions.

    • Integrations > actionFunction > Edit and View

      These permissions allow administrators to edit and view the function data action integration.

  • One or more installed Genesys Cloud Function data action integrations. For more information, see Add a data actions integration.

Runtime support

Current Node.js runtime versions are supported for Genesys Cloud Function data actions. For more information about currently supported runtime versions, see Release Notes. Genesys Cloud will periodically introduce support for newer Node.js runtime versions and deprecate older ones to ensure compatibility with evolving technologies and security best practices. Genesys Cloud alerts orgs via Operational Console notifications for Function data actions that use deprecated runtime versions.

For more information about Operational Console notifications, see Troubleshoot using the Genesys Cloud Operational Console.

Deprecation policy for runtime versions

A runtime version is announced deprecated three months before AWS initiates their Phase 1 deprecation. For more information, see AWS Lambda runtime deprecation policy. When the runtime version is marked for deprecation:

  • The existing Genesys Cloud Function data actions can operate until AWS Lambda makes the runtime version unavailable. You can make changes to the configuration and the custom code until the version is deprecated.
  • You cannot use deprecated runtime versions to create or update the data actions.
  • You can modify the Genesys Cloud Function data actions to use a new runtime.
  • The only change that you can make to a data action that is using an unavailable runtime is to use an available runtime version.
Note: Any runtime version change can require code changes.

Genesys Cloud

  • A Genesys Cloud organization.
  • A Genesys Cloud OAuth client to authorize access to the Platform API.

    When you add a Genesys Cloud data actions integration, you must add OAuth credentials to the integration configuration. For more information, see Create an OAuth client and Authorization (Genesys Cloud Developer Center). 

  • The following permissions (at a minimum) selected for the administrator of the integration and actions:
    Notes:
    • Depending on where you access the permissions in Genesys Cloud, the permission names appear in different formats.
    • Instead of selecting individual Integrations > Action permissions, you can select Integrations > Action > All Permissions. This permission grants administrators access to all current and future permissions associated with actions.
    • Integrations > Integration > Edit and View

      These permissions allow administrators to edit and view integrations.

    • Integrations > Action > Add, Delete, Edit, Execute, and View

      These permissions allow administrators to add, delete, edit, test, and view custom actions.

  • One or more Genesys Cloud data actions integrations. For more information, see Add a data actions integration.
  • Actions that access the Platform API with the HTTP methods GET, PUT, POST, or PATCH.

For more information about the integration, see About the Genesys Cloud data actions integration.

Google

  • A Google Cloud Platform or G Suite account. 
  • A project that grants API access to your Google Cloud Platform or G Suite APIs.
  • Configuration of Google Cloud Platform.

    For more information, see Configure Google Cloud Platform.

Genesys Cloud

  • A Genesys Cloud organization. 
  • The following permissions (at a minimum) selected for the administrator of the integration and actions: 
    Notes:
    • Depending on where you access the permissions in Genesys Cloud, the permission names appear in different formats.
    • Instead of selecting individual Integrations > Action permissions, you can select Integrations > Action > All Permissions. This permission grants administrators access to all current and future permissions associated with actions.
    • Integrations > Integration > Edit and View

      These permissions allow administrators to edit and view integrations.

    • Integrations > Action > Add, Delete, Edit, Execute, and View

      These permissions allow administrators to add, delete, edit, test, and view custom actions.

  • One or more installed Google data actions integrations. For more information, see Add a data actions integration.

For more information, see About the Google data actions integration.

Microsoft Dynamics 365

  • A user able to access any data that you want to make available to the Microsoft Dynamics 365 data action integration.

    Use this user’s credentials for the Microsoft Dynamics 365 credentials when you add the integration to your Genesys Cloud organization. For more information, see Add a data action integration.

  • The integration registered in Azure Active Directory.

    Use the application ID that is created when you add the integration to your Genesys Cloud organization. For more information, see Register the integration and Add a data actions integration.

Genesys Cloud

  • A Genesys Cloud organization. 
  • The following permissions (at a minimum) selected for the administrator of the integration and actions: 
    Notes:
    • Depending on where you access the permissions in Genesys Cloud, the permission names appear in different formats.
    • Instead of selecting individual Integrations > Action permissions, you can select Integrations > Action > All Permissions. This permission grants administrators access to all current and future permissions associated with actions.
    • Integrations > Integration > Edit and View

      These permissions allow administrators to edit and view integrations.

    • Integrations > Action > Add, Delete, Edit, Execute, and View

      These permissions allow administrators to add, delete, edit, test, and view custom actions.

  • One or more installed Microsoft Dynamics 365 data action integrations. For more information, see Add a data actions integration.

For more information about the integration, see About the Microsoft Dynamics 365 data actions integration.

Salesforce

Note: If you do not select these settings in Salesforce, all data actions associated with the integration will fail.
  • A user (preferably a system admin) able to access any standard and custom fields that are used in Genesys Cloud.

    Associate this user with a profile in Salesforce that has the following settings selected:

    • API Enable 
    • View All (for accounts, cases, and contacts) 

    When you add the integration in Genesys Cloud, use this user’s credentials for the Salesforce credentials. For more information, see Add a data actions integration.

  • Enable Allow OAuth Username-Password Flows settings in OAuth and OpenID Connect Settings. For more information, see Salesforce Release Notes.

Genesys Cloud

  • A Genesys Cloud organization. 
  • The following permissions (at a minimum) selected for the administrator of the integration and actions: 
    Notes:
    • Depending on where you access the permissions in Genesys Cloud, the permission names appear in different formats.
    • Instead of selecting individual Integrations > Action permissions, you can select Integrations > Action > All Permissions. This permission grants administrators access to all current and future permissions associated with actions.
    • Integrations > Integration > Edit and View

      These permissions allow administrators to edit and view integrations.

    • Integrations > Action > Add, Delete, Edit, Execute, and View

      These permissions allow administrators to add, delete, edit, test, and view custom actions.

  • One or more installed Salesforce data action integrations. For more information, see Add a data actions integration.

For more information about the integration, see About the Salesforce data actions integration.

Web service

  • A web service that supports the following items:
    • JSON-based web service calls.
    • No authentication, Basic authentication, user-defined authentication, or user-defined (OAuth) authentication. For more information, see Credential types.
    • HTTP methods GET, PUT, POST, PATCH, or DELETE.
    • An HTTPS endpoint on port 443. 
      Note: The integration does not support other ports. For more information, see Can we call a web service running on a port other than 443?.
    • TLS 1.2 or TLS 1.3 encryption protocol.
    • Presents a public-trusted certificate from one of the public certificate authorities that is trusted by Mozilla’s CA Certificate Program.
    • Provides all of the intermediate certificates during the TLS negotiation.

Genesys Cloud

  • A Genesys Cloud organization.
  • The following permissions (at a minimum) selected for the administrator of the integration and actions:
    Notes:
    • Depending on where you access the permissions in Genesys Cloud, the permission names appear in different formats.
    • Instead of selecting individual Integrations > Action permissions, you can select Integrations > Action > All Permissions. This permission grants administrators access to all current and future permissions associated with actions.
    • Integrations > Integration > Edit and View

      These permissions allow administrators to edit and view integrations.

    • Integrations > Action > Add, Delete, Edit, Execute, and View

      These permissions allow administrators to add, delete, edit, test, and view custom actions.

  • One or more installed web services data action integrations. For more information, see Add a data actions integration.
  • Authentication credentials added to the integration configuration in Genesys Cloud, if required for the web service.

For more information about the integration, see About the web services data actions integration.

Zendesk

  • A verified user in Zendesk (preferably an administrator for access control purposes).

    Use this user’s ID for the Zendesk credentials when you add the integration to your Genesys Cloud organization. For more information, see Add a data actions integration.

  • An API token.

Genesys Cloud

  • A Genesys Cloud organization. 
  • The following permissions (at a minimum) selected for the administrator of the integration and actions: 
    Notes:
    • Depending on where you access the permissions in Genesys Cloud, the permission names appear in different formats.
    • Instead of selecting individual Integrations > Action permissions, you can select Integrations > Action > All Permissions. This permission grants administrators access to all current and future permissions associated with actions.
    • Integrations > Integration > Edit and View

      These permissions allow administrators to edit and view integrations.

    • Integrations > Action > Add, Delete, Edit, Execute, and View

      These permissions allow administrators to add, delete, edit, test, and view custom actions.

  • One or more installed Zendesk data action integrations. For more information, see Add a data actions integration.

For more information about the integration, see About the Zendesk data actions integration.