Documentation Index

Fetch the complete documentation index at: https://help.symphonysummitai.com/llms.txt

Use this file to discover all available pages before exploring further.

Integrations

Prev Next

The Integrations provides a centralized interface for creating and managing integration flows. Each integration represents an end-to-end process that connects Apex with external applications to automate data exchange, streamline business operations, and orchestrate flows across connected systems.

The Integrations is designed specifically for integration flows and includes integration-specific information such as the associated project, version, execution status, and the activities used within the integration

Benefits

  • Automate Business Processes – Reduce manual effort by automating data exchange and end-to-end business processes across Apex and external applications.

  • Centralize Integration Management – Create, organize, and manage integration flows from a single interface using projects, versioning, and lifecycle status.

  • Improve Data Consistency – Synchronize information across connected systems to ensure accurate, consistent, and up-to-date data throughout the organization.

Use case

An organization uses Apex to manage internal incidents while a third-party support team uses ServiceNow. When a Priority 1 incident is created in Apex, the Integration Hub automatically creates a corresponding incident in ServiceNow and synchronizes updates such as priority, assignment, status, and resolution between both systems. This ensures that all teams work with the latest information, reduces manual effort, and accelerates incident resolution.

Configure Integrations

Use the Configure Integration to create an integration by entering its details, configuring the trigger, and completing the required settings.

To configure Integration, perform the following steps:

  1. Navigate to ITSM > Integration Platform.
    The Integrations list page is displayed, by default.

    Figure: Integration list page

  2. Click + New Integration to create a new integration.
    The Create Integration comprises the following steps:

    General Details

    The General Details step enables you to specify the basic information for the integration, including the name, associated project, and description.


    Figure: Create Integration

    Enter the required details as described in the following table and click Next: Trigger >.

    Field  

    Description

    Integration Name

    Enter a unique name to identify the integration. The integration name is displayed in the Integrations list and throughout the Integration Hub

    Project

    Select the project to which the integration belongs. Projects are used to organize and manage related integrations. By default, the name of the selected project is displayed.

    Description

    Enter a brief description of the integration, including its purpose or the business process it automates.

    Trigger

    Use the Trigger step to configure the event that starts the integration flow. Select the appropriate trigger type to determine how the integration is invoked. For example, a Webhook trigger initiates the integration by receiving HTTP POST payloads from external applications or services.

    Figure: Trigger step

    By default, Webhook radio button is selected to trigger receives HTTP POST payloads from external systems to initiate the integration flow. Click Next: Additional Information.

    Additional Information

    Use the Additional Information step to configure email notifications for integration failures. When enabled, the system automatically sends an email notification to the specified recipients if an error occurs during integration execution

    You can enable or disable the Enable Error Notification toggle based on your requirements. By default, the toggle is enabled. When enabled, you can configure To and Cc recipients to receive email notifications if an error occurs during integration execution.

    Figure: Additional Information

    On configuring the recipients, click Create & Open to view the Integration flow.


    Figure: Integration Flow

  3. Click Create & Open to Designer Canvas.
    The Designer Canva page is displayed.

    Figure: Designer Canvas

Webhook

The Webhook trigger enables an integration to receive HTTP POST requests from external applications and initiate the integration flow. For more information, refer Webhook.