How to Create a Lead Capture Key

Give a website form or another tool its own key, so the leads it collects arrive in your CRM.

A lead capture key lets another source send leads into your CRM. In the product the page is called Ingest Keys, and it describes itself as per-source API keys for the universal lead ingest endpoint. You make one key for each source, so you can tell them apart and switch one off without touching the others. This guide walks through creating a key, saving it and revoking it.

1. 1

   Open Ingest Keys

   Open Settings, go to Developer and choose Ingest Keys. If you do not see Developer in Settings, your role does not include it, so ask an admin. If your plan does not include this page, it shows a message and a link to plans instead of the list. When you have no keys, the page says so and invites you to create one.
2. 2

   Choose Create Key

   Choose + Create Key at the top right. The Create Ingest Key window opens.
3. 3

   Type the Source Label

   The Source Label is required. Use it to name where the leads come from; the hint offers examples such as a website form, Zapier or a marketplace. If you leave it empty, the window says that the source label is required.
4. 4

   Choose a default pipeline and stage

   Under Default Pipeline, which is optional, choose the pipeline that new leads from this source should enter. Once you choose one, a Default Stage list appears, also optional, with the stages of that pipeline. The window notes that when a default pipeline is set, the caller does not need to pass a pipeline in the request.
5. 5

   Check the scope

   Under Scopes you will find one choice, which lets the key create leads, meaning contacts and deals. It is ticked already. Leave it ticked for a key that sends leads.
6. 6

   Create the key

   Choose Create Key. The button reads Creating while it saves. Choose Cancel to close the window without saving. The window also has a link, View Ingest API documentation, which opens the documentation in a new tab.
7. 7

   Copy and save the key

   A window called Save Your Key Now opens and shows the key with a warning. It is shown this one time. Choose Copy to Clipboard, keep the key somewhere safe, tick that you have saved it in a secure location and choose Done. Done stays off until you tick the box.
8. 8

   Read the key and its usage

   The new key appears under Active. Its card shows the name, a status, the scope, when it was created, when it was last used and, if you chose them, the default pipeline and stage. Choose View 7-day usage to see, for the last days, a total and how many leads were created, how many were duplicates and how many failed.
9. 9

   Revoke a key

   To stop a key from working, choose Revoke on its card and then Confirm, or Cancel to keep it. A revoked key moves to the Revoked group, with the date it was revoked. It stays on the page so you have a record of it.

A few things worth knowing

The key is shown only once, when you create it, so copy it before you close that window. The page is built for one key for each source, so that the Last used date and the usage view tell you which source is working.

This guide covers the Ingest Keys page. It does not describe how to send a lead to your CRM, because that is in the documentation the page links to. To have your CRM send events out instead, the guide on creating a webhook subscription covers the Webhooks page. Leads that arrive go into the pipeline you chose, and the guide on managing your pipeline shows how your team works with them.