Skip to contentSkip to content
Frosvo
Developers

Create API keys and webhooks to connect your systems

Create a scoped API key, call the REST API, and receive signed webhook events when conversations start, messages arrive, chats are resolved or rated, and deadlines are missed.

Last updated

APIs and webhooks let your own systems read from and react to Frosvo.

Create an API key

  1. Go to Settings → API as an owner.
  2. Create a key and choose its scopes, the narrowest set that does the job.
  3. Copy the key when it is shown and store it in a safe place such as a secrets manager.
  4. Call the REST API with the key. The full reference is on the developers page and in the OpenAPI description.

You can create several keys, one per system, and delete one without affecting the others.

Add a webhook

  1. Open the webhook settings.
  2. Enter an https address on your server that can receive POST requests.
  3. Choose the events you want, such as new conversations, new messages, conversations resolved or rated, and missed deadlines.
  4. Save, and copy the signing secret.

Check the signature on every request, and answer quickly with a success status.

Retries and replays

If your server is down, Frosvo retries for about two days. Events can be replayed, so a gap in your system is recoverable. A webhook that keeps failing is switched off and appears on the Problems page.

Keep it safe

  • Never put a key in a web page or source code.
  • Rotate a key you suspect leaked: create a new one, switch over, delete the old one.
  • Review keys and webhooks from time to time in the audit log.

Related

See the developer overview, connect chat tools with Slack and the account connector, or use ready-made tools from plugins. Read about account security.

Common questions

Which should I use, the API or a webhook? Use the API when your system needs to ask Frosvo for something, and a webhook when Frosvo should tell your system the moment something happens. Many integrations use both.

Can I test a webhook? Point it at a test address you control, trigger the event in a test conversation, and check that your server verified the signature and answered quickly.

Frequently asked questions

Who can create API keys?

Owners, under Settings and then API.

What is a scope?

The part of Frosvo a key is allowed to use, such as reading conversations. Give a key only the scopes it needs.

How are webhooks protected?

Each event is signed, so your system can check it came from Frosvo. Events are retried for about two days and can be replayed.

Is creating a key visible to others?

Yes. Creating an API key or a webhook is recorded in the audit log and emailed to the other owners.

Keep going