Connect Cuevr to other tools

Understand the scope

Cuevr connects to your tools through an API v1 and webhooks, which you can use from Make, n8n or Zapier, among others. In one direction, Cuevr notifies your tool at every key moment of a proposal; in the other, your tool acts on Cuevr with an access key: creating a client or a proposal from a deal, closing or reopening the deal, reading the qualification.

Management features are in Admin, Organization tab, Integrations card, with an owner or administrator role. A member sees the card but can neither create a key nor add a destination.

Create and manage an access key

1. In Access keys, click Create an access key and give it a clear name.
2. In What the key can do, choose the permissions your workflow needs. Everything Make or n8n needs ticks all the permissions, None unticks them.
3. Click Create the key, then copy it when it is displayed: it will only be shown once.
4. Test the connection with the key verification route.
5. To replace a key, use Renew the key in the “…” menu of its row: Cuevr creates a new key with the same permissions, and the old one keeps working for the period shown in the confirmation window, long enough to replace it in your scenario.
6. Revoke the key with Revoke the key when it is no longer used or if it has leaked: it stops working immediately.

The key starts with cuevr_. To receive a family of events, the key that subscribes a destination must also have read permission for that family. When a member leaves the organization, or is no longer an administrator, the keys they created are revoked.

Add and manage a webhook destination

1. Click Add a destination, paste the Address provided by your scenario and, if you wish, a label.
2. In What Cuevr sends, select the events you need.
3. Tick Include reader data only if your tool must receive the prospect’s email and name.
4. Click Add the destination, then copy the signing secret: it will only be shown once.
5. Run Send a test from the destination’s “…” menu; the technical event is cuevr.ping.
6. Follow the Delivery log. If there is an error, fix the receiver, test again, then use Turn back on if the destination was turned off.

The organization can have up to 10 destinations. The response timeout is 10 seconds. Only an HTTP 2xx status counts as delivered. URLs must use HTTPS. On failure, Cuevr retries several times at increasing intervals, then turns the destination off after repeated failures; the cause is shown under its name. Events that occur while a destination is turned off are not caught up when it is turned back on. A failed test does not count against the destination. The delivery log is kept for 30 days.

The “…” menu also offers Edit, Turn off and Delete. When a member leaves the organization, the destinations they created are turned off; you can turn them back on.

Verify the signature of deliveries

Cuevr signs every delivery in the X-Cuevr-Signature header: an HMAC-SHA256 signature of the timestamp (X-Cuevr-Timestamp header) and of the body, computed with the destination’s secret. Have your receiving tool verify this signature before processing a delivery.

Renew the secret, in the destination’s “…” menu, creates a new secret. During the period shown, every delivery is signed with both: the new one in X-Cuevr-Signature, the old one in X-Cuevr-Signature-Previous. Paste the new secret into your scenario before the end of that period.

The twenty-one available events

Fifteen events are ticked by default when a destination is created:

Six events only go to the destinations that tick them:

A signature does not, on its own, record a sales outcome. Handle signature events and outcome change events separately.

What the API lets you sync

The routes cover key verification and the event catalog, viewing and managing clients, viewing proposals and creating them from a deal, closing and reopening the deal, reading the qualification, and managing, testing and logging webhooks. Publishing and signing remain actions done in Cuevr.

When a proposal is created from a CRM, the deal’s notes are kept as is at the top of the qualification and the language given is kept. The external source + external ID pair lets you replay creations without creating a new deal on each attempt. The owner email coming from the CRM must match a member of the organization. During the trial, a proposal created by the API counts toward that member’s trial proposals.

With an inactive subscription, access becomes read-only, with exceptions for turning off or deleting a destination and revoking a key. The key’s permissions and the member’s permissions still determine what is allowed.