Create webhook
Create webhook
Overview
Create webhook
Registers an outbound HTTPS endpoint and the event types you want delivered.
When to use this
Use once per environment when wiring your server to lomi. event notifications.
Good to know
Store the signing secret securely; verify signatures on every inbound request.
See also
Authentication
Merchant routes require an API key in the X-API-KEY header (see Integration overview). Use a test key against https://sandbox.api.lomi.africa and a live key against https://api.lomi.africa.
Endpoint
POST /webhooks
Base URLs:
https://sandbox.api.lomi.africahttps://api.lomi.africa
Request
Path parameters
No path parameters beyond the URL pattern.
Query parameters
No query parameters.
Request body
No application/json body for this operation.
Responses
| Status | Description |
|---|---|
201 | Created successfully |
Errors
Errors follow the standard JSON error format (status code and machine-readable message). Validate inputs before calling; 401 indicates a missing/invalid key, 404 a missing resource for this organization, 429 rate limiting. For safe retries on create-style calls, send an idempotency key when your flow supports it.
Example
curl -sS -X POST "https://sandbox.api.lomi.africa/webhooks" \
-H "X-API-KEY: $LOMI_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{}'OpenAPI
- operationId:
WebhooksController_create - Operation:
POST /webhooks
Full schemas and Try it: API reference. Machine-readable contract: repo apps/docs/openapi.json.