API keys, webhooks and AI assistants
Connect your own tools to Ferrylend: API keys for the REST API, webhooks that tell your systems when something changes, and the MCP server for AI assistants and coding tools that connect with an API key.
Open Settings → API keys and webhooks. Without the API and MCP access add-on the cards say what it does and offer to add it (owners add it in Settings → Billing). The full reference, with code samples, is in the developer docs.
Create an API key
- 1Click Create API key and name it after what will use it (your website, a reporting script, an AI assistant), so you can tell keys apart later.
- 2Choose its role (Manager, Processor or Read only) and its scopes: what it may read or change. A key can never do more than its role allows. Only owners create manager keys.
- 3Choose when it expires (a year is a good default) or tick Never expires, then Create key.
- 4Copy the key and store it as a secret. It is shown once.
Keys belong to the workspace, not to the person who made them, so an integration keeps working when someone leaves. When the person who made a key is deactivated or removed, owners get an email and the key is flagged until someone reviews it. Everything a key changes shows in the audit log and on the record's timeline as API key <name>. Your workspace's IP restrictions apply to keys too. Revoke a key from its menu and anything using it stops at once.
Webhooks
- 1On the Webhooks card click Add endpoint, paste your endpoint's HTTPS URL and choose its events (a new lead, a deal changing stage, an offer, a funded deal...) or Every event.
- 2Copy the signing secret and verify each delivery's signature on your side (the developer docs have code for Node.js and PHP).
- 3Click Send test event to check your endpoint. The log under each endpoint shows every delivery and its response, with Redeliver.
A delivery that fails is retried for about a day. An endpoint that fails every delivery for three days is turned off and owners get an email; Turn back on when it is fixed.
AI assistants (MCP)
AI assistants and coding tools that connect to an MCP server with an API key, such as Claude Code and Cursor, can search your leads and deals, add leads and notes and move deals through stages, with the key's role and scopes. Start with a read-only key. The developer docs show the setup for each tool, and which ones cannot connect with a key yet.
Leads from your website and lead vendors do not need an API key: give each one a lead intake source, on every paid plan (see Lead intake).
Zapier does not need the add-on either: it is included in every plan. Set it up in Integrations → Zapier, which makes the Zapier key it signs in with (see Integrations). A Zapier key also shows in the list above, marked Zapier; its role and scopes are fixed to what Zapier needs.