Framme

Webhooks

Instead of polling for order changes, register a callback URL and Framme will POST an event to it whenever something happens. Each event carries enough to act on it — order id/number, current status, tracking details and a timestamp.

Events

  • store_order_created
  • store_order_status_changed
  • store_order_shipped
  • store_order_delivered
  • store_order_cancelled

See the full payloads under Webhook events, or list the available types at runtime with GET /webhook/subscription/events.

Subscribe

Register one or more HTTPS callback URLs. Provide a token to sign payloads with, or let Framme generate one.

curl -X POST https://api.development.platform.framme.com/public/v1/webhook/subscription \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "event": "store_order_shipped",
    "hook_uri": "https://yourapp.example.com/framme/webhooks"
  }'

Manage subscriptions with GET, PUT and DELETE on /webhook/subscription/{id} — see the Webhook subscriptions reference.

Always verify the signature before trusting a payload, and make handling idempotent — see the next two pages.