This documentation is in beta, and might contain errors. Contact us at integration@instabee.com with any questions.

Instabee API

Events

Use Instabee webhooks to track shipment state changes and keep your internal systems in sync. Event setup and payloads differ by flow, so start with the section that matches your integration.

Choose Event Flow

  • Home Delivery Events: V2 webhook events configured in the Instabee merchant portal, including delivery updates, returns, and flow changes.
  • Locker Delivery Events: Checkpoint-based webhook events configured by the Instabee integration team, with customizable payload details.

What You Will Find

  • Authentication expectations for webhook callbacks.
  • Available event/checkpoint types per flow.
  • Payload examples and parameter breakdowns.
  • Timestamp format and integration notes.

Quick Integration Notes

  • Home delivery uses V2 events with headers such as Budbee-Event and Budbee-Event-ID.
  • Locker delivery uses checkpoint types and can be tailored for integration-specific requirements.
  • Build idempotent webhook handling keyed by the event/checkpoint identifier to safely process retries.

Command Palette

Search for a command to run...