Skip to main content

Managing IFX integration details

Use the IFX interface to view integration information, such as secrets, and to manage bundles.

The page includes the following tabs:

  • Details - Displays key information about the integration, such as status, description, contact email, and creation date. These fields match what's shown on the main Integrations page.

  • Secrets - Shows all secrets keys associated with the integration. This secure token is used to authenticate communication between Arc XP and an external service. The system never displays secret values, but you can modify them, as needed.

  • Bundles - Lists all bundles associated with the integration. From this tab, you can upload new bundles, download previous versions, and promote existing bundles as needed.

About integration bundles

Most tasks on the integration details page revolve around managing bundles. A bundle is a zipped code package that defines your integration's behavior. You build bundles locally and then upload them to the server, similar to how bundles work in PageBuilder and Themes.

When you first upload a bundle, its status is Unused. When you're ready, you can deploy and promote the bundle to make it the active version. You can promote only one bundle at a time. The promoted bundle is the code that Arc XP runs when the integration triggers.

Ensure you fully test your bundle before promoting it. If an issue arises, you can roll back by promoting a previously working bundle. In critical situations, to prevent unexpected behavior, you also have the option to disable the integration entirely.

Bundle statuses

Bundles can have any of the following statuses:

  • Unused - A bundle has been uploaded but is not yet deployed. You cannot promote the bundle in this state.

  • Deploying - The bundle is being deployed. This typically takes 30 to 40 seconds.

  • Deployed - The bundle has been successfully deployed and is ready to be promoted. You can identify this version by the deployVersion property.

  • Promoting - The bundle is currently being promoted to the live environment. This process usually takes about 10 seconds.

  • Live - The bundle is active and currently used by the integration.

Scenario: Updating an integration with a new bundle

After a third-party service updated its API, you need to revise your integration logic to ensure compatibility. Using the Bundles tab on the Integration details page in IFX, you upload a new version of the integration bundle with updated request handling.

After you test, you promote the bundle to make it live, which updates the integration without downtime or needing to recreate it from scratch. This streamlined workflow helps you maintain a reliable connection to the external service while minimizing manual overhead.

Procedures

Details tab

Reviewing IFX integration details

To view details about an integration in your environment, complete these steps:

  1. Navigate to IFX.

  2. Click Integrations. The Integrations page opens.

  3. Click the name of an integration.

  4. Click the Details tab.

  5. Review the following details for your integration:

    • Status - review the current status of the bundle. Enabled indicates the bundle is currently active.

    • Description - review the description for the integration.

    • Email - review the email address that receives notifications about the integration.

    • Date created - review the date and time the integration was created.

Secrets tab

Reviewing your IFX integration secrets

To view the secrets associated with your integration, follow these steps:

  1. Navigate to IFX.

  2. Click Integrations. The Integrations page opens.

  3. Click the name of an integration.

  4. Click the Secrets tab.

  5. Review the secret keys associated with this integration.

Bundles tab

Uploading a bundle to an IFX integration

The first step in configuring a bundle is to upload a zip file your integration bundle.

Note

The zip file must have a unique name.

  1. Navigate to IFX.

  2. Click Integrations. The Integrations page opens.

  3. Click the name of an integration.

  4. Click the Bundles tab.

  5. Click Upload bundle.

  6. Select the bundle you want to upload. The new bundle appears in the All bundles section with a status of Unused.

When you're ready, you can deploy the bundle.

Deploying an IFX integration bundle

After you upload a bundle, the next step is to deploy the bundle. Deploying a bundle makes the bundle available in the environment but it does not make it live.

You can deploy bundles in the Unused status only.

  1. Navigate to IFX.

  2. Click Integrations. The Integrations page opens.

  3. Click the name of an integration.

  4. Click the Bundles tab.

  5. Click icon_ellipsis.png > Deploy on to the bundle you want to deploy.

The bundle moves to the Deploying status and eventually to the Deployed status. The process takes 30 to 40 seconds.

You can now promote the bundle.

Promoting an IFX integration bundle

After you deploy a bundle, the last step is to promote the bundle to live.

You can promote bundles in the Deployed status only.

  1. Navigate to IFX.

  2. Click Integrations. The Integrations page opens.

  3. Click the name of an integration.

  4. Click the Bundles tab.

  5. Click icon_ellipsis.png > Promote on the bundle you want to promote.

The bundle moves to the Promoting status and eventually to the Live status. The process takes about 10 seconds.

Your integration now uses this bundle when it's triggered.

Downloading a copy of an IFX integration bundle

You can download existing versions of your bundle to review or make edits.

  1. Navigate to IFX.

  2. Click Integrations. The Integrations page opens.

  3. Click the name of an integration.

  4. Click the Bundles tab.

  5. Click icon_ellipsis.png > Download on any bundle in any status.

A zip file of the bundle downloads to your computer.

In this section: