← API Index


PushHook (v1)

The push hook configuration. When a URL is configured, push notifications (matching the type filter) are handed to that external provider instead of being sent by the platform itself

# Field Type Description
0 configured bool true if a push hook URL is set, i.e. matching push notifications are delegated to the external provider
1 url string target URL that receives one HTTP POST (JSON) per push notification
2 types string comma-separated push type names that are delegated, empty means all types. Possible values: ORDER_REMINDER (order deadline approaching, customer has not ordered), ORDER_CHANGE (order changed/confirmed by the operator), DELIVERY_CONFIRMATION (driver marked the delivery as done), DEPOSIT_REFUND_ANNOUNCE (deposit refund announced), FORGOTTEN_CART (items left in the cart), OTP (one-time password for login, time critical), ADMIN (message sent by hand from the admin area), SERIES (sent from the message queue: a series via /api/admin/message/series or /api/admin/pushactiongroup, or a single queued push from PCG)
3 errorMail string comma-separated email address(es) notified on delivery failure
4 errorCount int number of consecutive delivery failures since the URL was last changed

Used in endpoints

Referenced in skills