Activepieces is an open-source automation tool you can use in the cloud or run yourself. Use its HTTP piece to call Velaro and its Catch Webhook trigger to receive events from Velaro.

Before You Start

In Velaro, go to Settings → API Keys → Create API key, name it for Activepieces, 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 Activepieces

1. In your Activepieces flow, click + to add a step and choose the HTTP piece, then Send HTTP request.

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

3. Under Headers, add Authorization with value Bearer vlk_your_key and Content-Type with value application/json.

4. Paste the JSON body below into Body.

5. Click Test Step to run it.

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":["activepieces-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 Activepieces

To receive Velaro events in Activepieces, start a flow with the Webhook piece and its Catch Webhook trigger, then copy the URL. In the Velaro workflow editor add an HTTP Request node, paste that URL, set the method to POST and send a JSON body. Publish the flow so the live URL listens. You can also subscribe the URL to events with POST /webhooks (scope write:webhooks).

Troubleshooting

401 Unauthorized: check the Authorization header value includes the word Bearer and the full key.

Webhook not received: the draft URL differs from the published URL; publish the flow and use the live URL.

Contact not created: confirm the key has the write:contacts scope.