/settings?tab=api still land here.
Every member can see the section. The buttons that change anything (New API
key, Revoke, Add endpoint, and the pause, Test and remove controls
on an endpoint) appear for admins and the owner only.
There are no quotas here and nothing to buy. Create as many keys and endpoints
as your integrations need.
API keys
API keys authenticate the public REST API.Create a key
1
Name it
Press New API key and give it a name of up to 80 characters. Name it
after the integration that will use it, such as
Warehouse sync, so the
list stays readable and you know what a revoke will break.2
Choose its scopes
Tick only the scopes that integration needs. They are listed below.
3
Copy the key
Press Create key. The full key is shown once, in the dialog. Copy it
and store it somewhere safe.
watx_live_…. Keys issued before the product was renamed
begin converse360_live_ and still work; there is no need to rotate them.
Scopes
An endpoint declares the one scope it requires, and a key without that scope is refused.
A key with no scopes still authenticates. It can call
GET /v1/me to
confirm it works, and nothing else. The full mapping of scopes to endpoints is
on Authentication.
Using a key
Send it as a bearer token:The key list
Each key shows its name, the visible prefix, its scopes (or No scopes), when it was created, and when it was last used, or never used, which is the quickest way to spot a key nobody needs.
Keys created from this screen have no expiry date, so in practice a key is
active until someone revokes it.
Revoke a key
Press Revoke on the key’s row. It stops working immediately and cannot be un-revoked; the row stays in the list, marked Revoked, so you keep the record of what existed. Anything using the key starts getting401 at once.
To rotate a key, create the replacement first, move the integration over, then
revoke the old one.
Webhooks
A webhook endpoint is a URL on your server that Watx sends a signedPOST to
when something happens in the workspace, so you do not have to poll. This tab
manages the same endpoints as the API’s webhooks routes: one
you register here can be read through the API, and the other way round.
Add an endpoint
1
Open the dialog
Press Add endpoint.
2
Enter the URL
In Endpoint URL, paste an
https:// address that is reachable from the
public internet. Addresses on a private network or on your own machine are
refused.3
Pick the events
Tick at least one event under Events. They are grouped as
Messaging, Contacts and Forms & bookings, each with a line
saying when it fires. The full list is under Events.
4
Copy the signing secret
Press Add endpoint. The dialog changes to Endpoint added and shows
the signing secret, which starts with
whsec_. Press Copy, store it with
your other credentials, then press Done.X-Watx-Signature header on every delivery. The
recipe, with code, is on Webhooks.
The endpoint list
Each endpoint shows its URL, Active or Paused, how many events it receives, when something was last delivered (or nothing delivered yet), and the event names. Admins and the owner also get three controls:
Test sends an event named
api.test whose data holds a short message.
It goes out straight away rather than through the delivery queue, so the result
you see is your endpoint’s real answer: success, or the status code it returned.
It works on a paused endpoint too, and a failed test does not count against the
endpoint.
Endpoints that the Zapier and n8n
pages connect are managed on those pages and do not appear in this list.
Events
The Events tab lists every event a webhook endpoint can subscribe to, with when it fires and the keys its payload carries, plus the envelope that wraps every delivery.
Payloads for each event are on Webhooks.
Documentation
The Documentation tab is a short checklist for getting started: create a key on API keys, send it asAuthorization: Bearer <key>, and add a webhook
endpoint if you want events pushed to you. It links to this documentation’s
API reference and Postman collection, and
reminds you to verify a webhook signature over the raw request body.