Creating An Integration | Pandium Docs

For the complete documentation index, see llms.txt. This page is also available as Markdown.

The following steps will serve as a guide for creating an integration within Pandium. If this is the first time you're creating an integration or if you want a more detailed walkthrough, check out the guide for setting up an example integration here.

Choosing Your Integration Type

Pandium supports two types of integrations: internal and external. Internal integrations involve code execution, authentication, and activity management on the Pandium platform. Most developers will be creating internal integrations. On the other hand, external integrations are primarily used for pre-existing integrations, 3rd party collaborations, or marketing purposes. Marketers or partners often create these integrations.

Creating An Internal Integration

1. Navigate to the ‘Integrations’ resource and click ‘Create.’

2. In the pop-up widget, select ‘Internal.’

3. Configure your connectors:

• Most integrations will need a minimum of two connectors: your SaaS and the SaaS you are integrating with. There may be instances with more than two connectors, but they are uncommon.

• Each connector has a ‘global’ checkbox option, typically not needed. Use this when all end users will share the same authentication credentials, as in the case of an SFTP.

4. Configure your details:

• Integration ID: A backend unique identifier for the integration. For example, if integrating with Gorgias, it may be called “gorgias”.

• Integration Name: The public name for the Integration. End users will use this name to gauge what type of integration it is. Using the Gorgias example, the name may be “Gorgias Helpdesk.”

5. Configure your Remote Repository Settings:

• Repository URL: The URL where the integration code is hosted.

  • Repository Tracking Branch: The branch Pandium should use to create the integration.

  • Repository Path: The path where Pandium can find the Pandium.yaml. Leave it blank if the .YAML is in the root and is named ‘PANDIUM.yaml.’

6. Set your Sync Schedule options:

• Customize the sync schedule options you would like to offer to your end user for this integration. You may leave the default options if you choose.

7. 'Save the Configuration

8. Provision Connectors:

• Depending on the selected connectors, one or more of your connectors may need provisioning especially for SaaS using OAuth. Enter client id, client secret, and potentially select scopes.

• Grab Secret Keys for development purposes, specific to the SaaS. You can read more about Environment Variable Secrets, here.

9. You're Done!

Creating An External Integration

1. Navigate to the ‘Integrations’ resource and click ‘Create.’

2. In the pop-up widget, select ‘External.’

3. Provide relevant details for the integration.

• Integration ID: This serves as a backend unique identifier for the integration. For example, a Gorgias integration might be named “gorgias”.

• Integration Name: This is the public name for the Integration, used by end users to identify the type of integration. Using the Gorgias example, the name might be “Gorgias Helpdesk.”

4. Fill in the associated External Integration Settings:

• External Integration Url: This is the path to install or learn more about the integration. It could be a link to the 3rd party’s Integration Marketplace if hosted externally, or a deep link to the installation URL for pre-existing integrations on your SaaS platform. If used to gather Beta end users, it might link to a Google form or info page.

• External Integration ID: This ID is sent to Pandium by your engineering team in the marketplace JWT. This field is primarily used for pre-existing integrations, ensuring Pandium accurately shows whether the integration is installed for an end user.

• External Integration Link Target: Choose how the link opens in an end-user’s browser (new tab, same page, etc).

5. Upon saving, you’ll be prompted to fill in Marketplace Settings for this integration. You can read more about these settings here (link to Marketplace Settings).

Connecting to Source Control

Now that the integration has been created within Pandium, confirm that Source Control is set up by navigating to the ‘Settings’ in the sidebar, then “Source Control” to connect to your repository and set up the CI/CD pipeline. For more detailed information, view this article.

After connecting to Source Control, if code has been written, create a release from the “Settings” page. If not, go back to ‘Integrations”, click ‘Details’ on your new integration tile, and use the ‘Setup Integration Repo’ button to populate a quickstart for your code in your chosen language. Learn more about building releases for created integrations here.