API keys and webhooks

TopReach has a public API for contacts, companies, deals, projects, notes, tasks and more. It doesn't come with built-in integrations to other CRMs: you connect your own tools with API keys.

1. 1Go to Settings → Public API (Developer) (Developer · Public API).
2. 2Check that Public API access is on for the workspace.
3. 3Click Create key. Give it a Name, choose the Mode (Live or Test), and pick Scopes, or use Read all, Write all or Full access.
4. 4Click Create key and copy the key right away. It can't be shown again.

Give each key only the scopes it needs. Scopes cover reading, writing and deleting contacts, companies, deals, projects, notes, tasks and team members, plus reading custom fields, managing webhooks, and workbooks.

Rotate or revoke a key

• Rotate creates a new key. The old one keeps working for 24 hours, so you can update your integration without downtime.
• Revoke stops a key immediately and can't be undone. Revoke all revokes every key in that mode.
• A key's settings can limit it to an IP allowlist.

The Activity tab shows what your keys have been doing.

Webhooks

Webhooks are set up through the API rather than in the app. A key with the webhooks scopes can create, list, change and delete webhook subscriptions, send a test event, and rotate a subscription's signing secret.