| Parameter name | Description |
|---|---|
| notification_type | Type of the notification that triggered the callback. This can be one of the following: new_verified_reservation - new reservation with verified email address, reservation_confirmed - reservation confirmed by admin, reservation_admin_canceled - reservation cancelled by admin, reservation_user_canceled - reservation cancelled by client, reservation_admin_modified - reservation modified by admin, reservation_auto_canceled - reservation automatically cancelled, reservation_payment_received - online payment received, reservation_user_modified - reservation modified by client, vacation_modified - vacation was added, removed or modified, reservation_products_user_modified - additional products of reservation modified by client, reservation_price_updated - reservation price changed, checked_in - reservation status changed to checked-in, checked_out - reservation status changed to checked-out, noshow - reservation status changed to no-show hourly - hourly notification, added_to_waitlist - reservation request added to waiting list user_updated - new user has been added or user's settings were updated, coupon_payment_received - online payment for coupon received, confirmed_cleared - reservation 'confirmed' status was cleared, new_price_quotation - new price quotation, before_or_after_event_1...before_or_after_event_6 - before or after event #1..#6. custom_button_1...custom_button_5 - custom button clicked by an admin on the reservation details page resource_settings_changed - some settings of a resource changed reservation_payment_removed - reservation payment removed by admin coupon_payment_removed - coupon payment removed by admin resource_removed - resource removed reservation_removed - reservation removed |
| reservation | ID of the reservation. |
| resource | ID of the resource to be rented. |
| resource_name | name of the resource to be rented. |
| calendar | ID of the planyo site. |
| start | Start time (sent as timestamp, that is the number of seconds since January 1 1970 00:00:00). |
| end | End time (sent as timestamp). |
| user | ID of the user reserving the resource. |
| is_new_user | (used only with the user_updated notification: equals to 1 if this is a new user, 0 in case of modifications of user info |
| count | Number of resources being reserved. |
| creation_date | Creation time of the reservation. |
| status | Status of the reservation. See this page for the description of the status value. |
| currency | Currency of the reservation. |
| price_quoted | Rate quoted for the reservation. |
| discount | Discount applied through a voucher. |
| price_no_discount | Original price (without taking under consideration the voucher used, if any). |
| amount_paid | Amount paid already. |
| amount_outstanding | Amount left to be paid. |
| cart_id | ID of a cart, if using shopping cart. |
| payment_amount | Used only with reservation_payment_received notification; amount of the payment. |
| user_id, email, first_name, last_name, country, city, address, zip, state, phone | Customer's data. |
| is_event_fired_by_customer | If the event is triggered by a customer, the tag will have the value of 1. It will be 0 for other cases. |
| is_quiet | If the event is triggered in quiet mode (e.g. quiet cancellation of a reservation), the parameter will be passed with the value of 1. For other cases, the parameter is not passed. |
| affected_resources, package_contents | If the notification concerns an event that can change availability (like reservation made or vacation added), the affected_resources and package_contents fields will contain comma-separated resource ids whose availability also can be affects. This is the case only when the notification resource is a package (contains other resources) or is a part of a package. 'affected_resources' will contain ids of all parent package resources and package_contents ids of all child resources that are involved e.g. in a reservation. For example, let's say that resources A (id 1) and B (id 2) are included in packages P1 (id 3) and P2 (id 4). When resource A is reserved, affected_resources sent with e.g. the 'reservation_confirmed' notification will contain '3,4' - that is packages whose availability can also be modified after the reservation. On the other hand, if P1 is reserved and A is included in the reservation (B is not), 'package_contents' will contain '1'. |
| form_items | Names of the reservation form items also passed as separate parameters (see the note below) |
| user_properties | Names of the user property items passed as separate parameters to the script |
| unit_assignment | Unit assigned to the reservation (if any). |
| Parameter name | Description |
|---|---|
| type | One of the values: prepaid, entries, hours or days. To learn more about coupon types, see Q244. |
| coupon_is_site_wide | 'yes' for a coupon that works with all resources of the site, 'no' when a coupon is assigned to work only with a given resource; in the second case, resource parameter will contain the resource id. |
| coupon_purchased_amount | Number of purchased units (entries, days, hours, credits). |
| coupon_balance | The total number of units (entries, days, hours, credits) after the purchase. When an existing coupon is refilled by the purchase, this value reflects that total units. |
| coupon_price | Coupon purchase price. |
| coupon_purchase_currency | Coupon purchase currency. |
| coupon_email | Email address for which coupon was purchased. |
| is_coupon_access_email | If 'yes', access to coupon is limited to the email address; 'no' otherwise. |
| is_coupon_access_code | 'yes' when code is needed to use coupon; 'no' otherwise. |
| coupon_code | Code assigned to coupon. |
| is_coupon_personal | 'yes' when coupon can be used only by one person; 'no' otherwise. |
| payment_time | Time when payment was made. |
| holder_fields, buyer_fields | Comma-separated parameter names corresponding to the Additional holder info and Additional buyer info fields as defined on the Coupon purchase template page. The values will be passed as the parameters with the name format holder_field_xxx and buyer_field_yyy respectively. For example, for buyer_fields=age,color, the values will be passed as buyer_field_age and buyer_field_color |
| Parameter name | Description |
|---|---|
| relative_to | the event can be relative to 'start' - reservation start, 'end' - reservation end or 'reservation' - reservation creation time |
| time_difference | time difference in minutes |
| Parameter name | Description |
|---|---|
| resource_id | ID of the resource whose settings were modified |
| type | (optional) when applicable, settings group that triggered the notification |
| subtype | (optional) when applicable, more info about the settings changed |
| Parameter name | Description |
|---|---|
| removed_payment_amount | amount of the payment being removed |
| removed_payment_currency | the currency |
| removed_payment_time | the payment date and time |
| removed_payment_mode | the payment mode |
| Parameter name | Description |
|---|---|
| update_type | One of 'new', 'modified' or 'removed'. |
| vacation_type | vacation recurrence type related with the modification: 1 - one-time, 2 - repeated everyday, 3 - repeated every weekday, 4 - repeated every month, 5 - repeated every year, 99 - multiple vacations update, e.g. after import of vacations from a CSV file. |
| start_time, end_time | Vacation start and end time period. Please note that meaning of these values differs depending on vacation type. For 'one-time' vacation, this is simply the start and end time; 'repeated everyday' - start and end time (hour and minute) of the vacation; 'repeated every weekday' - the weekday of start_time is the day when vacation is repeated on week basis. Start and end time is the time; 'repeated every month' - start and end values carry the days when the vacation starts and ends; 'repeated every year' - start and end values carry the month and day when the vacation starts and ends. |
| valid_from, valid_until | If any limit is applied, the start and end date of the period to which the vacation is limited. |
| prev_start_time, prev_end_time | In case of vacation update, these are the previous start and end time values. |
| prev_valid_from, prev_valid_until | In case of vacation update, these are the previous limit values. |
| site_id | Your site ID. |
| is_site_vacation | 'true' for global vacation and 'false' for resource vacation. |
| resource_id | For resource vacation, ID of the resource. |
| updated_vacation_ids | IDs of the vacations. |