Getting started

Authentication and API keys

Every request to the NUWAY API is authenticated with your company's API key.

Get your API key

In the NUWAY dashboard, open Settings › Integration › API Key.
Copy your API key. It is shown in full only once, right after it is created. Store it somewhere safe, such as your server's environment variables or a secrets manager.

Each company has one API key. API actions are recorded as the team member who created the key.

You need an API key

Create, copy or regenerate it on the API Key page. The full key is shown only once, when it is created.

Go to API Key

Send the key with every request

Send your key in the X-API-KEY header on every request.

X-API-KEY: nwk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

A request without the header returns 401 with "Missing X-API-KEY header.".
An unknown, revoked or replaced key returns 401 with "Invalid or revoked API key.".
After 20 invalid keys within 5 minutes from one address, that address gets 429 for 5 minutes.

Keep the key on your server

Anyone who has it can read your conversations and leads and change your training data. Never put it in browser JavaScript, mobile apps or public repositories. If a key leaks, regenerate it.

Managing your key

On the API Key page you can:

Regenerate the key. A new key is issued and the old one stops working immediately, so update your integrations right away.
Revoke the key. The API stops accepting it until you generate a new one.
See when it was last used.
Request a higher rate limit (see Rate limits).

See Security for how to store and rotate the key safely.