API Keys

API keys allow automated access to your CRM data, synchronize data with other systems, and create custom integrations or solutions.

For example, you can use them to retrieve details of a specific Person or Company record, such as their name or address.

Generate an API key

1. Go to Settings in the sidebar on the left.
2. Under Workspace, go to Developers. Here, you'll see a list of active keys that you or your team have created.
3. To generate a new key, click on + Create key at the top right.
4. Give your API key a name, an expiration date, and a logo.
5. Hit save to see your API key.
6. Since the key is only visible once, make sure you store it somewhere safe.

Regenerating an API key

To regenerate an API key, click on the key you want to regenerate. You'll then be able to see a button to regenerate the API key.

Webhooks

Webhooks allow for immediate updates to your specified URL about changes or events related to your customer data.

For instance, a webhook can alert your system in real-time when someone creates a new person record or updates an existing note.

Creating Webhooks

1. From Settings -> Developers, click + Create webhook.
2. Enter your URL.
3. Click Save.

Deleting Webhooks

1. In Developers, find your webhook.
2. Click on your webhook and press Delete to remove it. A confirmation popup will appear to confirm.

Noticed something to change?

As an open-source company, we welcome contributions through Github. Help us keep it up-to-date, accurate, and easy to understand by getting involved and sharing your ideas!

Edit Content