See also

20 Nov 2024 09:25 PM

Set up an integration blueprint

Creating a developer account

  1. Go to https://userintegration.getconduit.app/.
  2. Click on "Sign Up."
  3. Provide your email address and create a new password.
  4. When the login window appears, enter the email and password you just created.

Creating an integration

You will now see a list of your integrations. Let’s create a new one.
The integration editor will open. Here are its main components:
clipboard-2024-10-22-23-45-54-378Z.png

  • Commands for Integration Management:
    • Test: Reads data from the data source.
    • Sync: Reads data from the source and sends a CSV file to Conduit.
    • Save: Saves the integration settings.
    • Share: Generates a shareable link for the integration.
    • Deploy: Makes the integration available to end users.
  • Configuration Elements:
    • JSON: Displays the integration configuration file.
    • Parameters: Lists parameters available to end users.
    • Script: Allows editing of a Python script, if data merging is required.
  • Monitoring Tools:
    • Logs: Shows the integration status after execution.
    • Received Data: Displays the JSON data received from the remote source.
    • Extracted Data: Shows the CSV file that will be sent to the webhook.

Conduit will automatically generate a JSON configuration file, which can be used as a template to explore and create your own integration.

Test the integration

You can test the configuration, but first, you need to create a webhook in Conduit to receive the data.

  1. Click the "Test" button, then open the "Extracted Data" tab. You’ll see that the integration generates three columns.
    clipboard-2024-10-22-23-47-35-353Z.png

  2. These columns must be set up in the webhook. To do this:

  3. Copy the webhook URL token
    https://api.getconduit.app/push/755614f1-0309-4d4a-8e4d-ad6821a63a24/receive/.

  4. Add the webhook token as the CONDUIT_WEBHOOK_TOKEN parameter.
    clipboard-2024-10-22-23-49-56-925Z.png

  5. Now, click the "Sync" button. You should see a confirmation message indicating success.
    clipboard-2024-10-22-23-51-35-311Z.png

  6. To verify that all data has been received, create a dashboard in Conduit.
    clipboard-2024-10-22-23-52-19-173Z.png
    clipboard-2024-10-22-23-52-32-682Z.png

close