- Documentation
- Guide · Version 1.0
- API keys and webhooks
API keys and webhooks
On this page
An API key lets an application — your website, your shop — publish through the API on behalf of the workspace; a webhook tells that application, with a signed call, when a publication changes state.
The API keys and Webhooks menus are reserved to the workspace's administrators and owner. How the API itself works is described in the API reference.
Create an API key
Menu API keys, then Create an API key:
| Field | Note |
|---|---|
| Name | Required, 100 characters at most. It tells you which application uses the key: "Website", "Shop". |
| Brand | Optional. Left empty, the key covers "Whole workspace". A key bound to a brand neither sees nor publishes anything of the others. |
| Permissions | At least one. Each right opens part of the API: see Scopes. |
Create the key opens the Your new API key window, which shows the Identifier (qsc_…) and the Secret (qss_…), each with a copy button.
The secret is shown only once. Copy it before closing the window with I have copied the secret: it can never be read again, only replaced by a new key.
A key also connects a conversational assistant to Quiet Social, through the MCP server: it will read your publications and prepare drafts with the key's rights. Create a separate key for it, with only the rights it needs and, if possible, restricted to one brand.
Follow and revoke a key
The list shows, for each key, its Name, its Identifier, its Brand, its Permissions, its Last used and its Status: Active or Revoked. The Active only filter is applied by default.
A key cannot be edited. To change its rights or its brand, create a new one, switch the application over, then revoke the old one.
Revoke cuts the application's access from its next request. A revoked key cannot be reactivated.
Creating and revoking a key are recorded in the history, as are registering, editing, reactivating and deleting a webhook.
Register a webhook
Menu Webhooks, then Register a webhook:
| Field | Note |
|---|---|
| Address | Required. In https, on a public address: a local, private or reserved address is refused as soon as it is entered. |
| Events | At least one, taken from the catalog. |
| Brand | Optional. Left empty, the endpoint receives the events of "Whole workspace". Bound to a brand, it only receives that brand's events. |
Register opens the Signing secret window. Your application uses it to verify the signature of each call. It is shown only once: copy it before closing with I have copied the secret.
Webhooks registered through the API appear in this list, and those registered here are visible to the API: it is the same endpoint.
Manage a webhook
The list shows the Address, the Brand, the Events, the Status — Active or Suspended —, the number of consecutive Failures and the Last success. Each row's menu offers:
- Send a test: a check notification,
webhook.test, goes out by the same path as a real one. Its outcome appears in the endpoint's deliveries. A Suspended endpoint does not receive a test: reactivate it first. Five tests per minute and per endpoint at most, dashboard and API combined. - Reactivate, for an endpoint Suspended after repeated failures or a refused URL: first check that it responds again. The URL is checked once more, and a URL that is still forbidden prevents reactivation. The failure counter starts again from zero, and the suspension will come back if nothing has changed.
- Edit the URL or the events. The brand cannot be changed.
- Delete: the URL receives nothing more, and the history of its deliveries goes with it.
Deliveries
A webhook's page repeats its state — including the date of the Last failure — and lists its Deliveries, most recent first: the Event, the Status, the number of Attempts, the Response (the HTTP code returned by your application) and the Date.
| Statut (Status) | Meaning |
|---|---|
| Pending | The delivery is waiting for its first attempt or for a retry. |
| Delivered | Your application answered with a 2xx code. |
| Failed | Every attempt failed. |
| Address refused | At sending time, the URL led to a forbidden destination; the endpoint is suspended. |
Deliveries are kept for 30 days. Retries and suspension are detailed in the webhooks reference.