FOODSbyme
API reference

Webhook Events

React to network events as they happen.

Subscribe to webhook events to keep your systems in sync without polling. FOODS signs every payload so you can verify authenticity. Events fire across the order and settlement lifecycle.

Capabilities

  • Subscribe to lifecycle events
  • Verify signed payloads
  • Automatic retries with backoff
  • Replay recent events from the dashboard

Endpoints

POST/v1/webhook_endpoints

Register a webhook endpoint

GET/v1/webhook_endpoints

List your endpoints

DELETE/v1/webhook_endpoints/{id}

Remove an endpoint

Example event payload

Request
// Events you can subscribe to
order.created
order.assigned
order.picked_up
order.delivered
order.cancelled
settlement.paid
Response · 200 OK
{
  "id": "evt_5Tg9",
  "type": "order.delivered",
  "created": "2026-06-13T11:02:55Z",
  "data": {
    "order_id": "ord_8Kd2",
    "rider_id": "rdr_19f3",
    "delivered_at": "2026-06-13T11:02:50Z",
    "payout": { "currency": "NGN", "amount": 850 }
  }
}

Ready to integrate?

Request a partner key and our solutions team will help you go live.