Send a test notification
Sends a fictional sale to one channel now (email: to the signed-in caller only). 200 whether the delivery worked or not (ok, and why it failed); 400 when there is nothing to send to: no webhook URL set, or an email asked by an API key or by a caller who cannot read the site's revenue.
Requires site:update on the site (an API key, or a signed-in member's role). Share links: 401.
x-api-key<token>An organization API key (ak_…), with the permissions and the sites it was created with. For servers and scripts: no cookie and no Origin check. Also accepted as Authorization: Bearer ak_… (apiKeyBearer). A request carries one credential: a key sent with a share token or a live session cookie is 400 (details.reason: ambiguous_credentials).
Scope: site:update
siteId*stringapplication/json- body
channel*stringemail goes to the signed-in caller only; a webhook gets the message even while switched off
"email""slack""discord"OK
application/json- response
data*curl -X POST 'https://pilotfox.app/api/v1/sites/string/notifications/test' \ -H 'Content-Type: application/json' \ -d '{ "channel": "email"}'{ "data": { "ok": true, "message": "string" }}