Events & Integration
Inbound webhooks
Receive provider callbacks through /webhooks/<app>/<service>/<method> endpoints.
Inbound webhooks are provider callbacks received by Antly. The generic route is:
/webhooks/<app>/<service>/<method>The route dispatches to a provider method for the named app and service. Product examples include Paystack, Flutterwave, Anchor, Stripe, Meta, and mail-related providers. ShopByAntly's Paystack receiver, for example, uses:
POST /webhooks/shopbyantly/paystack/process-event
GET /webhooks/shopbyantly/paystack/process-eventThe GET form is commonly used as a health or verification check when a provider supports it.
Provider payload pattern
Provider payloads are usually not JQL envelopes. They are the JSON, form body, or signed request shape sent by the upstream provider. Antly's provider service validates signatures, resolves tenant or account configuration, then performs JQL/model work internally.
1POST /webhooks/billing/billing/process_paystack_webhook
2Content-Type: application/json
3X-Paystack-Signature: <provider-signature>
4
5{
6 "event": "charge.success",
7 "data": {
8 "reference": "INV-2026-00042",
9 "amount": 250000,
10 "currency": "NGN",
11 "status": "success"
12 }
13}When to add a new inbound webhook
Add a provider webhook when the external service must call Antly directly and the payload format is owned by that service. Do not use the generic inbound route for normal client integrations; those should call POST /jql with api_key, oauth2, or jwt.
For outbound notifications from Antly to another service, use /developer/outbound-webhooks. For hosted payment links that end users open directly, see /developer/payment-links.