Getting started
Quickstart
Set up an app in the dashboard, configure your backend, and send your first report and webhook in a few minutes.
Set up the app in the dashboard
These steps need a person with the role admin or owner in the Limenia dashboard at https://app.limenia.eu. A coding agent cannot do them; ask the user to do them and to put the resulting values into environment variables or secrets.
- Finish the setup wizard of the tenant. Until it is finished, reports answer 403
tenant_not_active(GET /v1/pingworks already). - Create the app: Apps → Create app, with a name and the backend you use. The slug (lowercase letters, digits, hyphens, at most 40 characters) cannot be changed later and appears in every webhook as
app.slug. Use a separate test app for testing: there is no sandbox, and every API key writes to the real system (see Testing). - Create an API key: tab Connection → API keys → Create API key. The key (
lm_live_plus 43 Base62 characters) is shown exactly once; Limenia stores only its SHA-256 hash. Store it asLIMENIA_API_KEYin your backend’s secret store. An app can have several keys; to rotate, create a new one, deploy it, then revoke the old one (a revoked key stops working within 30 seconds). See API keys. - Set the webhook: tab Connection → Webhook, enter your HTTPS URL (at most 2048 characters, public, no private or internal addresses, no redirects) and save. The first save turns the webhook on and shows the signing secret (
whsec_…) once. Store it asLIMENIA_WEBHOOK_SECRET. Rotate secret shows a new one once and applies it immediately to all following delivery attempts. - Send test webhook (same place) sends a
test.pingonce (5 s timeout, no retry; again after 10 s at the earliest) and shows HTTP status, duration and error code. - Supported actions (tab General): restrict the actions moderators can choose to those your app can carry out.
dismissis always possible.
Important: Decisions taken while the webhook is not active (no URL or secret, or switched off) are never delivered by webhook, also not after switching it on. Reconcile users with
GET /v1/subjects/{externalUserId}/statusif that happened.
The app page has the tabs Overview, General, Connection (API keys, webhook), Connectors (Firebase, Supabase, RevenueCat, device connector, store reviews), Moderation (approval types, signal types and rules, AI pre-screening) and DSA (store requirements, transparency database). The home page shows a checklist of open setup steps.
Configure your backend
Every example and every snippet in this documentation uses the same variables:
LIMENIA_BASE_URL=https://app.limenia.eu # without /v1, this is the default
LIMENIA_API_KEY=<set by the user, never in code>
LIMENIA_WEBHOOK_SECRET=<set by the user, never in code>
LIMENIA_WEBHOOK_SECRET_PREVIOUS= # optional, only while rotating the secret
LIMENIA_IDENTIFIER_KEY= # optional, only for ban evasion across appsLIMENIA_IDENTIFIER_KEY belongs to ban evasion across apps, which is coming soon.
Check the key
Check address and key with one call:
curl -sS "$LIMENIA_BASE_URL/v1/ping" -H "Authorization: Bearer $LIMENIA_API_KEY"{ "tenantId": "01K6…", "appId": "01K6…", "appSlug": "photoapp", "tenantStatus": "active" }"tenantStatus":"onboarding" means the setup wizard is not finished yet. A 401 means the key is wrong or revoked.
Send a first report
Send it to the test app only:
curl -sS -X POST "$LIMENIA_BASE_URL/v1/reports" \
-H "Authorization: Bearer $LIMENIA_API_KEY" -H "Content-Type: application/json" \
-H "Idempotency-Key: report-quickstart-1" \
-d '{"source":"user","reasonCategory":"spam","reporter":{"externalUserId":"quickstart_reporter"},"subject":{"externalUserId":"quickstart_author"},"content":{"externalContentId":"quickstart_content_1","contentType":"comment","text":"Limenia quickstart"},"externalReportId":"quickstart_1"}'The answer is 201 Created with reportId, caseId and caseCreated. The case appears under Cases in the dashboard. All fields are in Reports.
Receive the decision
- Deploy a webhook receiver that verifies the signature (see Webhooks; every integration guide has one) and enter its URL in the dashboard.
- Press Send test webhook: your receiver gets a
test.ping. - Decide the quickstart case in the dashboard, e.g. with
dismiss. Your receiver getsdecision.createdandreports.resolved(see Webhook events).
Next steps
- Pick the complete path for your stack in Choose your path.
- Read the Hard rules and API basics.
- Verify everything with Testing and go through the go-live checklist.