...
Properties can enable a webhook notification url at the property level. If enabled we will send a POST notification to the notification url, authenticated via basic auth against the username and password provided as shown via the example below.
json request object to the notification url every time a request is created or updated. The property has control over if they wish to use a notification url or not, and may turn it on or off by editing their property details as shown below.
Requirements
- The webhook url must support HTTPS. We will automatically convert any http or non defined url to https upon saving the webhook url.
- The webhook url must support POST method.
- The webhook url must support BASIC Authentication and the username and password.
- If enabled MyGuests will send a json request object to the webhook url for every request that is created or updated. The partner should use filtering logic as appropriate to capture/discard messages based upon their desired needs.
Sample Webhook Json Request Object
| Code Block |
|---|
{
"id": 881,
"booking_id": "1796110W",
"room": "32",
"guest": {
"name": "Joe Banks",
"email": "joeb@banks.com",
"phone_number": null
},
"created_at": "2020-02-26 14:48:08",
"updated_at": "2020-03-10 15:28:34",
"length_open": "1 week",
"status": "Completed",
"assigned": "John Doe - BookingCenter",
"category": {
"id": 24,
"name": "Housekeeping"
},
"request_details": [
{
"name": "Details",
"value": "Room Cleaning Required",
"amount": null,
"type": "text"
}
],
"comments": {
"guest_comments": [
{
"details": "Room is being cleaned",
"created_at": "2020-03-02 12:01:24",
"staff": "mary"
},
{
"details": "Hi",
"created_at": "2020-03-02 13:24:54",
"staff": "tom"
},
{
"details": "Lets Test This out",
"created_at": "2020-03-02 14:26:02",
"staff": "ellen"
}
],
"staff_notes": [
{
"details": "Hi",
"created_at": "2020-03-02 12:01:13",
"staff": "ellen"
}
]
}
} |