This article will show you how to integrate SHOEBOX Online with Pipedream, in order to seamlessly pull participant contact information and test results into a lead management platform.
In this article:
How it works
- SHOEBOX Online Test is completed
- SHOEBOX Online sends a notification to the configured webhook URL (Pipedream URL).
- Pipedream receives webhook and initiates workflow.
- Pipedream performs an HTTP request to retrieve the complete test data from the SHOEBOX Online API.
- Pipedream forwards the SHOEBOX Online data to an external CRM system.
Setting up Pipedream
Step 1: Create a new workflow in Pipedream by clicking the New button on the right.
Step 2: Set up the workflow trigger. In our case, we will be using an HTTP Trigger to kick off the workflow every time a test is completed using the SHOEBOX Online API Webhook feature.
Step 3: Copy the Pipedream Webhook URL, configure the SHOEBOX Online API to send notifications to that URL by pasting it in the URL field on the SHOEBOX Online Results API page, and click Save.
Step 4: Add a HTTP Request step in Pipedream.
Step 5: Configure the HTTP Request step to pull data from SHOEBOX Online API URL.
Step 6: Add an HTTP Header to authenticate your request to the SHOEBOX Online API
Step 7: Enable the trigger by hitting the toggle in the top-right of the card. Click Save, followed by Deploy. At this point, we need to test the trigger in order to confirm it is working and to also tell Pipedream what data will be received from the API.
Step 8: Navigate to your SHOEBOX Online test URL and complete a test. Once completed, Pipedream should indicate a successfully triggered workflow and you will be able to confirm that the data is received in the second workflow step.
Step 9: Now that we have the data flowing into Pipedream, we want to send it to an external system. This will be different depending on each target platform. In this example, we’ll be using https://webhook.site/ as a target to receive our data. Add a custom HTTP request step.
Step 10: Configure the endpoint URL and the HTTP Request method to tell Pipedream where you are sending the data.
Step 11: Configure the “Post Body” to include the retrieved data from the SHOEBOX Online API that occured in the second step of your workflow. You can do this by clicking on “Select Path” of the return value of the second workflow step.
Step 12: Click Save and then Deploy. Our workflow is now fully completed. Now, when a SHOEBOX Online test is completed, this workflow will trigger, pulling the data from the SHOEBOX Online API and sending it to https://webhook.site.
