Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2,265 changes: 1,622 additions & 643 deletions package-lock.json

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions packages/v1-ready/reevo/.env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Reevo public API key, sent as the `x-api-key` header.
# Find it under Settings → API in your Reevo workspace.
REEVO_API_KEY=your_reevo_api_key_here
16 changes: 16 additions & 0 deletions packages/v1-ready/reevo/LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
MIT License

Copyright (c) 2022 Left Hook Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or
substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
102 changes: 102 additions & 0 deletions packages/v1-ready/reevo/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
# Reevo API Module

A [Frigg](https://friggframework.org) API module for **Reevo** — the AI-native
Revenue OS (CRM). It lets a Frigg app read and write Reevo accounts, contacts,
opportunities, tasks, activities, and sequence enrollments.

## Authentication

Reevo uses a **static API key** sent in the `x-api-key` header (no OAuth). Find
your key under **Settings → API** in your Reevo workspace.

- Base URL: `https://api.reevo.ai/api/v1/public`
- Auth header: `x-api-key: <your key>`
- Docs: https://help.reevo.ai/Data-management-and-migration/Integrations-With-Other-Tools

Set the key locally via `.env`:

```
REEVO_API_KEY=your_reevo_api_key_here
```

## Usage

```js
const { Api } = require('@friggframework/api-module-reevo');

const reevo = new Api({ api_key: process.env.REEVO_API_KEY });

// Upsert an account + contact in one call
await reevo.upsertAccountContact({
email: 'jane@acme.com',
first_name: 'Jane',
last_name: 'Doe',
company: 'Acme',
account_website: 'https://acme.com',
});

// Create an opportunity on an account
const opp = await reevo.createOpportunity({
display_name: 'Acme — Platform License',
account_id: '…uuid…',
amount: 25000,
});

// Move it to a new stage (stage changes go through shift_stage, not update)
await reevo.shiftOpportunityStage(opp.id, { target_stage_name: 'Negotiation' });

// Log a call / meeting-intelligence summary as a manual activity
await reevo.createManualActivity({
metadata: {
activity_time: '2026-08-19T17:00:00Z',
subject: 'Discovery call',
category: 'CALL',
description: 'Summary + next steps from the recorded call.',
},
account_id: '…uuid…',
});
```

## Methods

| Method | Endpoint | Notes |
|---|---|---|
| `upsertAccountContact(body)` | `POST /account_contact?payload_type=json` | Requires `email` |
| `createAccount(body)` | `POST /accounts` | Requires `name` |
| `updateAccount(id, body)` | `PATCH /accounts/{id}` | |
| `getAccount(id)` | `GET /accounts/{id}` | |
| `searchAccounts(body)` | `POST /accounts/search` | Requires `domain_name` |
| `getContact(id)` | `GET /contacts/{id}` | |
| `searchContacts(body)` | `POST /contacts/search` | Requires `contact_email` or `owner_email` |
| `createOpportunity(body)` | `POST /opportunities` | Requires `display_name`, `account_id` |
| `updateOpportunity(id, body)` | `PATCH /opportunities/{id}` | Stage changes use `shiftOpportunityStage` |
| `getOpportunity(id)` | `GET /opportunities/{id}` | |
| `searchOpportunities(body)` | `POST /opportunities/search` | |
| `shiftOpportunityStage(id, body)` | `POST /opportunities/{id}/shift_stage` | Requires `target_stage_name` |
| `createTask(body)` | `POST /tasks` | Requires `title`, `owner_email` |
| `createManualActivity(body)` | `POST /manual_activities` | Requires `metadata.activity_time/subject/description` |
| `searchUsers(body)` | `POST /users/search` | Requires `email` |
| `searchMailboxes(body)` | `POST /mailboxes/search` | Requires `owner_user_email` |
| `createSequenceEnrollment(body)` | `POST /sequence_enrollments` | Requires `contact_email`, `sequence_id` |
| `retrieveAccountAndContact(params)` | `GET /account_and_contact_retrieval` | Exactly one of `contact_email` / `account_domain` / `contact_phone_number` |

`custom_fields` (dict) is accepted on accounts, contacts, and opportunities.
Write permissions on a resource automatically include read.

## OpenAPI spec

Reevo does not publish its own OpenAPI document, so `reevo.openapi.yaml` in this
package is the canonical machine-readable contract — authored from Reevo's
help-docs reference. The client in `api.js` mirrors it 1:1 (one method per
`operationId`). Use the spec to generate typed clients, validate requests, or
drive an `openapi-client-axios` client (see the Marketo module for that
pattern). A test asserts the spec and client stay in sync.

## Testing

```
npm test
```

Tests are fully offline — the API surface is exercised against captured requests
and the auth/definition wiring against stubs (no live Reevo key required).
Loading
Loading