How can we help you?

Pipedream Guide

Pipedream lets you build workflows from event sources and steps, with the option of code in any step. Use its built-in HTTP / Webhook action to call Velaro and an HTTP / Webhook trigger to receive events from Velaro.

Before You Start

In Velaro, go to Settings → API Keys → Create API key, name it for Pipedream, and choose the scopes you need: read:contacts and write:contacts for the examples here. Copy the key (it starts with vlk_) because it is shown only once. Create one key per tool so you can rotate it independently.

Connection Details

  • Base URL: https://api-admin-us-east.velaro.com/api/v1
  • Authorization header: Authorization: Bearer vlk_your_key
  • Content type: application/json

Never put the key in a URL. See the REST API Guide for every endpoint and scope.

Call Velaro from Pipedream

1. In your Pipedream workflow, click + to add a step and choose HTTP / Webhook, then Send any HTTP Request.

2. Set Method to POST and URL to the endpoint you need.

3. Add a header Authorization with value Bearer vlk_your_key. Store the key as a Pipedream environment variable and reference it instead of pasting it.

4. Set the body type to JSON and paste the body below.

5. Click Test to run the step.

Example: Create a Contact and Tag It

Create or update a contact with a POST to https://api-admin-us-east.velaro.com/api/v1/contacts:

{"email":"jane@example.com","firstName":"Jane","lastName":"Doe","company":"Acme","tags":["pipedream-lead"]}

The reply includes the contact id and the tags applied. To add a tag later, send a POST to https://api-admin-us-east.velaro.com/api/v1/contacts/tag with:

{"email":"jane@example.com","tag":"escalation-needed"}

The tag is created if it does not exist, and any Email Campaign set to start on "Contact tag added" begins for that contact.

Send Velaro Events to Pipedream

To receive Velaro events in Pipedream, create a workflow with the HTTP / Webhook trigger and copy its unique URL. In the Velaro workflow editor add an HTTP Request node, paste that URL, set the method to POST and send a JSON body. The payload appears in the trigger event so you can use it in later steps. You can also subscribe the URL to events with POST /webhooks (scope write:webhooks).

Troubleshooting

401 Unauthorized: check the header is exactly Bearer plus a space plus your full key.

No event in the trigger: make sure the workflow is deployed, then send the Velaro event again.

400 Bad Request: confirm the body is valid JSON with an email field.

Share: Email

Was this article helpful?