Guides / Settings and team

The lead API key

One endpoint, one key. Your website form posts a name and an email, and a project appears at Lead stage with the client's intake link already made.

What you need first

  • The owner role
  • Someone who can change your website's form, or a tool that can post to a URL

Leads that arrive as a forwarded email are leads that get lost. By the end of this page your website form will be able to write straight into Casework, and the key that lets it will be in your password manager.

Open Settings, then People, and read the Lead API card

It prints the whole contract: the endpoint to post to, the header to send, and the shape of the body. Two fields are required, the client's name and their email, and everything else is optional.

The Lead API card, showing the endpoint, the authorization header and the shape of the body, with Generate key under the line saying no key is set
  1. 1The endpoint, the header and the body
  2. 2With no key, the endpoint rejects everything
  3. 3Generate key

The address in the picture is the workspace these screenshots came from. Yours prints your own.

Click Generate key

The key appears once, in a box of its own, with a warning under it: copy this now, it cannot be shown again, and a lost key is regenerated rather than recovered. Only the first few characters are stored, which is what the card shows afterwards.

The Lead API card just after a key is generated, with the key in a box of its own and the warning that it cannot be shown again
  1. 1The prefix, which is all that is kept
  2. 2Revoke key, which turns the endpoint off
  3. 3Shown once, and stored nowhere

The key itself is hidden in that picture. It is a credential, and one does not belong on a public page.

Put it in your website form

Send it as Authorization: Bearer and the key. Keep it on your server, not in a page a visitor can read, because anyone holding it can create projects in your workspace.

Read what comes back

The endpoint creates a project at Lead stage and returns the client's intake link, so your own thank-you page can hand it straight to them and the form becomes the first step of the intake rather than the end of one.

Regenerate when you need to

Regenerate key issues a new one and revokes the old one immediately, which the card says beside the prefix. Anything still posting with the old key stops working the moment you press it, so change your form first.

Revoke it if the form goes

Revoke key leaves the endpoint rejecting everything, and the card goes back to saying no key is set. This is one endpoint with one key, not an integrations framework, and there is nothing else to unwind.

What happens next

The last guide in this section is the opposite direction: getting your rates and your client list back out of Casework.