Pipedream Quick-Start Guide
With a few simple steps, start using Pipedream to send Confection data to hundreds of different endpoints.
Issues? Questions? Feedback? Leave a comment. Already have a Confection account? Already installed Confection on your site or app? Skip to step four. New to Confection? Learn more here.
If you haven’t already, create a Confection account. If you already have a Confection account, log in.
Click “My Account” (or “Set Up My Account” if you’re accessing your account for the first time). Enter your contact information, the domain(s) on which you want to use Confection, and select one of our two data storage options. Then, click “Save Changes.”
Click "API Keys" (or "Get My Keys" if you're accessing your account for the first time). Copy your account ID and API keys. You'll need them in the next step.
At this point, you'll want to make sure you've installed Confection on your site. If you haven't started writing data to your account, you won't see any information when you set up Pipedream.
If you need to install Confection, click "Install Confection" inside your Confection account and/or see our quick-start guides.
Once Confection is installed on your site -- and assuming you haven't already -- set up a Pipedream account. Then, depending on whether you want to use the Pipedream web interface or the CLI, proceed as follows.
Note, for more information on Confection API endpoints, consult the API panel in your Confection account dashboard.
Log in to your account, and create new workflow by clicking Workflows > New in your account dashboard. In the "Select a trigger" menu, search for "Confection." Then, select one of the available triggers.
New Event
Equivalent to the leads/event/{event_name} Confection API endpoint.
New Field Value
Equivalent to the leads/field/{field_name} Confection API endpoint.
New or Updated Leads
Equivalent to the leads Confection API endpoint.
All triggers return dedicated events for every item associated with a JSON input field.
On the next screen, click "Connect Confection" and enter the account ID and API keys you copied in step three.
Next, configure the trigger properties, set the timer, and enter the relevant event name. Confection tracks common, best-practice events like loadtime and pageviewBatch out of the box. However, if you wanted to track an event named button-click, you'd enter button-click here.
To learn how to begin tracking custom events on your site, see "Sending Custom Events/Information" here: dashboard.confection.io/docs/client
Click "+" to add a new step to your existing workflow. In the "Add a step" menu, search for "Confection." Then, select one of the available actions.
Get Full Details of UUID
Equivalent to the {UUID}/related Confection API endpoint.
Get Related UUIDs
Equivalent to the {UUID}/full Confection API endpoint.
All actions return data directly from the Confection live API.
On the next screen, click "Connect Confection" and enter the account ID and API keys you copied in step three.
Next, configure your action properties as follows:
First, download Confection's Pipedream files from your account's integrations dashboard. Then, install the Pipedream CLI and log in.
Sources
Run pd deploy sources/[source-folder]/[source-file].mjs;, and configure using the account ID and API keys you copied in the previous step. Use the following source folders and files:
new-event/new-event.mjs
Equivalent to the leads/event/{event_name} Confection API endpoint.
new-field-value/new-field-value.mjs
Equivalent to the leads/field/{field_name} Confection API endpoint.
new-updated-leads/new-updated-leads.mjs
Equivalent to the leads Confection API endpoint.
All sources return dedicated events for every item associated with a JSON input field.
Actions
Run pd publish actions/[action-folder]/[action-file].mjs. Use the following action folders and files:
get-related-uuids/get-related-uuids.mjs
Equivalent to the {UUID}/related Confection API endpoint.
get-uuid-details/get-uuid-details.mjs
Equivalent to the {UUID}/full Confection API endpoint.
All actions return data directly from the Confection live API.
Questions or comments about using Confection with Pipedream? Leave them below.
You can also use the chat app in the lower right corner.