Authentication

Ovellan has a small REST API for developers who want to go past the embed script. It uses three separate credentials, each for a different job, and the chat widget on your site needs none of them.

The three credentials

Keep these straight and the rest is easy. The Bot ID is public; the API key and sync key are secrets you keep on your own server.

• Bot ID, the public id of one chatbot. It travels in the request body as bot_id and is safe to put in front-end code.
• API key (awk_…), a secret Bearer token for the Chat API. Send it as Authorization: Bearer awk_….
• Sync key (awsk_…), a secret for product sync and Zapier. Send it in the X-Sync-Key header.

Create an API key

Open Customer API under your account, click Create key, name it, and pick which bot it can talk to. The key is shown once, so copy it straight away. You can revoke it any time, and the Chat API is available on the Business and Enterprise plans.

Authorization: Bearer awk_YOUR_KEY

Generate a sync key

Open your bot, go to its Integrations page, and generate the sync key there. Regenerating it invalidates the old one immediately, so update it anywhere you use it.

X-Sync-Key: awsk_YOUR_SYNC_KEY