API keys and webhooks (if a developer helps you)
A plain-language overview of Settings > API & Webhooks, so you can work with a developer or a tool like Zapier safely.
Most practices never need this page. It's for when a developer, or a tool like Zapier, needs to read or update your Flourivate data, or wants to hear about events (like a new contact) the moment they happen. This overview tells you enough to hand over the right thing and keep it safe.
Before you start
- You need: to be the workspace owner or an admin.
- Know which you need:
- An API key lets another tool read and change your data: contacts, deals, messages, workflows and more.
- A webhook sends a message to another tool's web address whenever something happens in Flourivate.
- Only connecting one workflow to another app? Workflow webhooks are simpler. See Connect another app with webhooks.
Go to Settings > API & Webhooks (in Channels & Infrastructure). It has three tabs: Workspace Keys, Webhooks and Workspace Docs.
Create an API key
- On Workspace Keys, click Create Key.
- Name it after the tool that will use it, like "Zapier" or "Website developer".
- Copy the key when it's shown and paste it straight into the other tool, or give it to your developer through a password manager.
A workspace key only reaches this workspace. It can't see or create other workspaces.
An API key is a master key
Anyone with it can read and change your client data. Never paste it into email, chat or a support request. If you think it's been shared, delete it (the trash icon on its row) and create a new one. Deleting a key stops anything that uses it.
Send events to another tool (webhooks)
- Click the Webhooks tab, then New Webhook.
- Enter a Webhook Name and the Endpoint URL your developer or tool gave you. It must start with
https://. - Under Events, tick what should be sent, for example Contact Created, Tag Added, Deal Won or appointment events. Select All and Clear are there too.
- Leave Active on, then click Create Webhook.
- A signing secret is shown once, after you create it. Copy it for your developer. It lets their system check each message really came from Flourivate.
Preview sample payload shows your developer what each message looks like.
For your developer
The Workspace Docs tab is the reference for this workspace's API: the base address, how to sign in with a key, quick-start examples and every resource (contacts, opportunities, calendars, conversations, forms, products and more). Point your developer there.
Check it worked
- Your key appears on Workspace Keys with its name and created date.
- Ask your developer to trigger a test event. It arrives in their system.
If something's off
- You can't find API & Webhooks: your role doesn't include it. Ask the workspace owner.
- You lost the key or signing secret: they're shown once. Delete it and create a new one.
- The other tool says "unauthorized": the key was deleted or copied wrong. Create a fresh key.
- Events don't arrive: check the webhook is Active and the right events are ticked.
- Need more help? We can explain what's possible, but we can't build custom integrations. A developer can. See Get help.