Get Started

Upload and Connect your Custom Integration

Once your integration code is ready and fully tested locally. The next step is to upload it and connect your custom integration in Secoda.

Upload your Custom Integration

  1. Navigate to the Create Integration Page: Click on the Integrations in the side bar, navigate to the Create tab, and select Create Integration.

  1. Enter Integration Details: Fill in the submission form with the integration name, upload an integration icon, and provide a detailed description of your integration.

  1. Script Upload: Next, upload your integration script in the form of a python file.

  1. Configure User Inputs: List the user input fields that your script requires. In the example below, the fields for email and password are mandatory. password must also be flagged as sensitive to maintain the security of user credentials. The fields listed must directly match the code.

  1. List Endpoint Permissions: Clearly list all the HTTP/HTTPS endpoints your script interacts with. This is a critical step that allows Secoda to validate the endpoints and allow the outbound traffic safely. This step ensures secure and seamless operation of your integration.

Once your custom integration has been created, the next step is to Connect your custom integration.

Connect your Custom Integration

Your custom integration is now available to connect. The integration will be immediately available in the Browse tab of the Integration Marketplace as a Draft. Integrations in Draft are only visible to the workspace that the integration was uploaded in.

You can also connect to the integration through the Create tab, by expanding the menu of the integration card.

Now you can connect to your integration by filling in the credential details listed previously. Submit the details, and a sync will begin to run!

Create a New Version

You also have the option to create new version of your custom integration to update details such as icon, description, or implementation.

Once fully tested, you can submit your integration (or new version) to the Marketplace. See Publishing to Marketplace for more details.

Last updated