Skip to main content

​
Overview

Setting up RevyOps takes about 5 minutes. You will:
  1. Obtain your API key
  2. Configure a webhook in your sending platform
  3. Verify data is flowing into your workspace

​
Step 1 — Get Your API Key

Every REST API request (contacts, companies, emails, etc.) is authenticated with an X-API-KEY header, not a client_id. RevyOps looks up your workspace from the API key server-side, so you never send client_id on these calls. You can find your API key in the RevyOps dashboard under Settings → Workspace. You’ll also find your client_id in the same place. It identifies your workspace in webhook URLs (see Integrations), but it is not a credential — it isn’t used to authenticate anything, so treat it as a routing identifier rather than a secret.
Keep your X-API-KEY secure. It is the credential that authenticates your API calls — anyone who has it can read and write your workspace data.

​
Step 2 — Connect a Sending Platform

Choose the platform you want to connect and follow the guide:

Instantly

Set up Instantly webhooks

SmartLead

Set up SmartLead webhooks

Lemlist

Set up Lemlist webhooks

EmailBison

Set up EmailBison webhooks

​
Step 3 — Verify the Connection

After configuring the webhook, send a test event from your platform. In the RevyOps dashboard:
  1. Go to Campaigns
  2. Look for the campaign you triggered the event from
  3. Confirm that sends, replies, or bounces are showing up
Most platforms send a test payload when you save the webhook. Check the Emails section to confirm the record was received.

​
Step 4 — (Optional) Connect HubSpot

If you use HubSpot as your CRM, follow the HubSpot integration guide to sync contacts and companies bidirectionally.

​
Next Steps

Campaign Analytics

Understand your campaign metrics

API Reference

Automate with the REST API