Delivery · testDelivery
Send a test
POST /v1/delivery/test
Sends the signed-in member a test through one of their own deliveries (push, browser, email, telegram, slack or whatsapp): "Logu test · this is how an ask will look", rendered like a real ask with Approve and Decline that do nothing. It is not an ask (nothing is created or decidable) and it ignores quiet hours; quietHoursIgnored says so when a real ask would have been held. result is sent, not_connected (nothing is set up for it), unavailable (this server doesn't send it) or failed. Humans only, up to 5 per minute. Records delivery.tested.
- Who may call it
- any signed-in human
- Server
- https://api.logu.dev
Request body#
Content type application/json (required).
| Field | Type | Required | Notes |
|---|---|---|---|
delivery | "push" | "browser" | "email" | "telegram" | "slack" | "whatsapp" | required |
{
"delivery": "telegram"
}
Example#
curl -s -X POST "https://api.logu.dev/v1/delivery/test" \
-H "Authorization: Bearer $LOGU_SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{"delivery":"telegram"}'
Responses#
200
What the test attempted.
{
"delivery": "telegram",
"result": "sent",
"count": 1,
"quietHoursIgnored": false
}
Response fields
| Field | Type | Required | Notes |
|---|---|---|---|
delivery | "push" | "browser" | "email" | "telegram" | "slack" | "whatsapp" | required | |
result | "sent" | "not_connected" | "unavailable" | "failed" | required | |
count | integer | required | 0–∞ |
quietHoursIgnored | boolean | required |
Errors#
Every error is {"error":{"code","message","hint","docUrl","requestId"}}: branch on code. See Errors.
| Status | Code | Meaning |
|---|---|---|
| 400 | bad_request | The request is malformed or a field is invalid (see issues). |
| 400 | unknown_field | The body has a field the endpoint doesn't know (often a typo or snake_case). |
| 401 | unauthorized | No credentials, or the API key or session is invalid or revoked. |
| 403 | forbidden | The caller is authenticated but may not do this (wrong role, or an API key on a human-only endpoint). |
| 429 | rate_limited | This API key sent too many requests, or a human did too much too fast: sign-in attempts, workspaces created in a day, or a global daily cap on new accounts was reached. |
| 500 | internal_error | Something went wrong on Logu's side. |