Developers

Events

Every event Zaher sends, when it fires, and what it contains.

Subscribe each endpoint to the events it needs. Full payload schemas and examples are in the Reference section of the sidebar.

Orders

data is the full order: status, totals, customer, billing and shipping addresses, and line items. Money values are decimal strings ("149.00") in the order's currency.

EventFires when
order.createdAn order is placed — including unpaid (pending) orders and orders created manually in the dashboard.
order.completedAn order is paid and completed.
order.status_changedAn order's status changes. data.previous_status holds the old value.
order.canceledAn order is canceled.
order.refundedAn order is refunded.

One change can produce several events. When an order goes from pending to completed you receive both order.status_changed and order.completed — subscribe to whichever fits your workflow.

Order statuses

draft, pending, pending_payment, captured, confirmed, completed, canceled, failed, refunded.

Channels

data.channel tells you where the order came from: storefront, marketplace, zaher or dashboard (created by hand in the dashboard).

Bookings

data is the consultation booking: date, time and timezone, duration, meeting method and link, the related order and product, and the customer.

EventFires when
booking.createdA booking is created.
booking.acceptedA booking is accepted.
booking.canceledA booking is canceled.

Booking statuses

initiated, pending, accepted, canceled.

Customer data

Payloads include the customer's name, email, phone and addresses so you can fulfil orders and sync your CRM. Treat them as personal data — see Security.

On this page