API - Planyo Web Services - add_notification_callback

Vous êtes ici: Planyo » Aide » API » add_notification_callback



Adds a webhook (callback) for specified event. This is the same as adding the URL to site settings / notifications / notification callbacks. Note that multiple webhooks are possible for a single event. If you leave callback_url empty, all webhooks for given event will be removed.


notification_name string required
Notification for which the webhook is being added. One of: new_verified_reservation - new reservation with verified email address, reservation_confirmed - reservation confirmed, reservation_admin_canceled - reservation cancelled by admin, reservation_user_canceled - reservation cancelled by customer, reservation_admin_modified - reservation modified by admin, reservation_auto_canceled - reservation automatically cancelled, new_price_quotation - new price quotation added, reservation_payment_received - online payment received, reservation_user_modified - reservation modified by customer, reservation_products_user_modified - additional products modified by customer, checked_in - check-in, checked_out - check-out, noshow - 'no show' notification, hourly - hourly notification, coupon_payment_received - payment received for a coupon, user_updated - user settings updated by admin or client, reservation_price_updated - price of existing reservation was changed
callback_url string optional
URL of the callback (webhook) to be added to the webhooks for given event.
method string required
must be set to add_notification_callback
language string optional
by specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returned
api_key string required
your API key - Click here to get your key. If your API key uses a hash key, you must also include the parameters hash_key and hash_timestamp.



API playground:

Click here to test this function in the API playground.