How can we help you?

Workato Guide

Workato connects business apps through recipes. Use its HTTP connector (an HTTP connection plus the Make request action) to call Velaro, and a Webhook trigger to receive events from Velaro.

Before You Start

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

1. In Workato, open Tools, then Connections, and create an HTTP connection. Set the Base URL to https://api-admin-us-east.velaro.com/api/v1.

2. Set Authentication type to Header auth, header name Authorization, value Bearer vlk_your_key.

3. In your recipe, add the HTTP action Make request, pick that connection, and set Request type to POST with the path you need (for example /contacts).

4. Set Request body format 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":["workato-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 Workato

To receive Velaro events in Workato, create a recipe with a Webhook trigger (New event from the Webhooks by Workato connector) and copy the webhook URL. In the Velaro workflow editor add an HTTP Request node, paste that URL, set the method to POST and send a JSON body. Start the recipe so the URL listens. You can also subscribe the URL to events with POST /webhooks (scope write:webhooks).

Troubleshooting

401 Unauthorized: confirm the connection header value begins with Bearer and the key is active in Settings → API Keys.

Recipe does not trigger: the recipe must be started for the webhook URL to accept events.

404 Not Found: check the path begins with /contacts and the Base URL ends in /api/v1.

Share: Email

Was this article helpful?