sendTestNotification
POST
/api/v1/notifications/test
const url = 'https://example.com/api/v1/notifications/test';const options = {method: 'POST'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/notifications/testSend a test notification to the caller’s own address. Requires an authenticated dashboard user with the write scope. Cookie-authenticated unsafe requests require X-CSRF-Token.
Parameters
Section titled “ Parameters ”Header Parameters
Section titled “Header Parameters”X-CSRF-Token
string
Cookie-backed browser requests only, and only on unsafe methods. Bearer grants never send it.
Responses
Section titled “ Responses ”Test notification sent
Media typeapplication/json
object
data
required
object
sentTo
required
string format: email
Examplegenerated
{ "data": { "sentTo": "hello@example.com" }}No address or address invalid
Dashboard authentication required
Email not configured
Mail server rejected the message