RivalBeam API

Integrate competitive intelligence directly into your workflows. Automate competitor tracking, pull intelligence into your CRM, and trigger actions when competitors make moves.

Base URL

https://rivalbeam.com/api

Format

JSON (Content-Type: application/json)

Error Format

json

{
  "error": "Competitor limit reached. Upgrade your plan.",
  "status": 403
}

Quick Start

1. Create an API key at Settings → API Keys
2. Add the header Authorization: Bearer rb_xxxxx
3. Make your first call:

bash

curl -s https://rivalbeam.com/api/competitors \
  -H "Authorization: Bearer rb_xxxxx" | jq .

Authentication

All API requests require a valid API key. API keys are scoped to your organization and inherit your plan's rate limits and feature access.

Creating an API Key

Go to Settings → API Keys in your dashboard
Click Generate New Key
Give it a descriptive name (e.g., "CRM Integration")
Copy the key immediately — it won't be shown again

Header Format

bash

Authorization: Bearer rb_xxxxx

Example Request

bash

curl https://rivalbeam.com/api/competitors \
  -H "Authorization: Bearer rb_live_a1b2c3d4e5f6" \
  -H "Content-Type: application/json"

Security:Never expose API keys in client-side code or public repositories. API keys have full access to your organization's data. Rotate compromised keys immediately from Settings.

Competitors

Manage the competitors your organization tracks. Adding a competitor kicks off automated monitoring across all configured channels within minutes.

Changes / Intelligence Feed

The intelligence feed contains every change RivalBeam detects across all monitored channels. Each change has a significance score (0–100) calculated by AI analysis.

Briefs

AI-synthesized intelligence briefs that summarize competitive activity. Available as weekly digests, on-demand reports, competitor comparisons, or market-wide analyses.

weeklyon_demandcomparisonmarket

Deep Research

Deep Research uses Claude Opus 4 to produce comprehensive competitive analysis reports. These reports take 2–5 minutes to generate and cover product, market position, tech stack, hiring signals, and risk assessment.

Async operation: POST returns immediately with status pending. Poll GET /api/research/:id until status becomes complete or failed. Alternatively, configure a webhook for the research.completed event.

Battlecards

Auto-updating competitive battlecards for your sales team. Battlecards include strengths, weaknesses, pricing comparison, objection handling, and talk tracks. They auto-update when new intelligence is detected.

Deals (Win/Loss)

Track competitive deal outcomes to build win/loss intelligence over time. Correlate wins and losses with specific competitors and surface patterns your team can act on.

Webhooks (Outgoing)

Receive real-time notifications when events occur in your RivalBeam organization. Configure webhook endpoints from Settings → Webhooks.

Supported Events

change.detected

A new competitive change is detected

brief.generated

An intelligence brief is ready

competitor.added

A new competitor is added

deal.recorded

A deal is logged or updated

battlecard.updated

A battlecard is auto-updated

research.completed

A deep research report is ready

Payload Format

json

{
  "event": "change.detected",
  "timestamp": "2026-04-01T08:15:00Z",
  "data": {
    "id": 1001,
    "competitor_id": 42,
    "competitor_name": "Acme Corp",
    "channel": "pricing",
    "title": "Enterprise plan increased from $299 to $399/mo",
    "significance_score": 88,
    "source_url": "https://acme.com/pricing"
  }
}

Signature Verification

Every webhook delivery includes an X-RivalBeam-Signature header containing an HMAC-SHA256 signature of the request body using your webhook secret.

typescript

import crypto from "crypto";

function verifyWebhook(body: string, signature: string, secret: string): boolean {
  const expected = crypto
    .createHmac("sha256", secret)
    .update(body, "utf-8")
    .digest("hex");
  return crypto.timingSafeEqual(
    Buffer.from(signature),
    Buffer.from(expected)
  );
}

Retry Policy

Failed deliveries (non-2xx response or timeout) are retried up to 3 times with exponential backoff: 30s, 5min, 30min. After all retries fail, the delivery is marked as failed and visible in your webhook delivery log.

CRM Webhook (Incoming)

Receive deal data from your CRM via webhook. RivalBeam uses DataReconIQ-powered matching to automatically link incoming deals to tracked competitors.

Zapier / Make.com Setup

In Zapier/Make, add a new Webhook (POST) action
Set the URL to https://rivalbeam.com/api/integrations/crm/webhook
Add header Authorization: Bearer rb_xxxxx
Map your CRM fields to the payload schema above
Set the trigger to fire on deal stage changes (e.g., "Closed Won" or "Closed Lost")

bash

# Example: Send a deal from your CRM via curl
curl -X POST https://rivalbeam.com/api/integrations/crm/webhook \
  -H "Authorization: Bearer rb_live_a1b2c3d4e5f6" \
  -H "Content-Type: application/json" \
  -d '{
    "deal_name": "Enterprise Widget Co",
    "deal_value": 48000,
    "outcome": "won",
    "competitor_name": "Acme Corp",
    "win_reason": "Better onboarding experience",
    "rep_name": "Sarah K.",
    "source": "hubspot"
  }'

Slack Integration

Connect RivalBeam to Slack for real-time competitive intelligence alerts and on-demand lookups. Configure from Settings → Integrations.

Slash Commands

/rivalbeam [competitor]Get a quick summary of recent activity for a competitor

/rivalbeam briefTrigger an on-demand brief and post it to the current channel

/rivalbeam changes [competitor]List the latest high-significance changes for a competitor

Alert Delivery Format

When a high-significance change is detected, RivalBeam posts a rich Slack message:

RivalBeam Alert2:15 PM

Acme Corp — Pricing Change Detected

Enterprise plan increased from $299 to $399/mo

Significance: 88/100 • Channel: pricing • View in RivalBeam

Incoming Webhook Setup

Go to Settings → Integrations → Slack
Click Connect to Slack and authorize the RivalBeam app
Select the channel for alert delivery
Configure minimum significance threshold and channels to monitor

Rate Limits & Plans

API rate limits vary by plan tier. Exceeding the limit returns a 429 Too Many Requests response with a Retry-After header.

Plan	Price	Rate Limit	Competitors	Users	Deep Research	Briefs/mo
Free	$0	`10/min`	1	1	0	0
Starter	$99/mo	`60/min`	5	3	0	4
Growth	$199/mo	`120/min`	15	10	2	8
Pro	$399/mo	`300/min`	30	25	10	30
Agency	$799/mo	`Unlimited`	100	Unlimited	Unlimited	Unlimited

Rate Limit Headers

Every API response includes rate limit information in the headers:

http

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 57
X-RateLimit-Reset: 1712000000

Need higher limits or a custom plan?

Contact Sales