Webhooks: Guests
Webhook notifications for the creation, alteration and deletion of guest objects.
Guesty's Open API allows you to send various guest-related webhook notifications to your application's notification URL(s).
What Notifications Can I Receive?
Guest notifications are sent by Guesty for the following events:
Why Create Guest Webhooks?
Once your Guesty Open API integration is complete and finished with its initial synchronization of data, we recommend you to utilize the guests webhook notifications. Webhook notifications will help you save time and resources. Plus, you get to only synchronize the guest data that has changed or is new and ignore that which has remained in the same state since the initial synchronization.
Guest Created Notification
This webhook notification is sent whenever a new Guest is created within your Guesty account. Learn how to create this webhook here.
Notification Payload
| Body Parameter | Data Type | Description |
|---|---|---|
guest | object | The new guest record. |
by | string | The source of new Guest record. |
event | string | guest.created |
Guest Created Notification Example
{
"guest":{
"airbnb":{
"id":88419363516114
},
"airbnb2":{
"index":"index",
"id":88419363628340
},
"policy":{
"marketing":{
"isAccepted":false,
"dateOfAcceptance":null
},
"termsAndConditions":{
"isAccepted":false
}
},
"verifications":[
],
"emails":[
"[email protected]"
],
"phones":[
"12016665626"
],
"communicationMethods":[
"email",
"sms"
],
"paymentMethodIds":[
],
"interests":[
],
"allergies":[
],
"dietaryPreferences":[
],
"tags":[
],
"_id":"6310a0759dcce60032e95a6c",
"firstName":"Gerald",
"lastName":"Charlton",
"email":"[email protected]",
"accountId":"62a8a2be2e53190032102a6e",
"pictures":[
],
"paymentProvidersCustomers":[
],
"fullName":"Gerald Charlton",
"phone":"12016665626",
"__v":0
},
"by":"[email protected]",
"event":"guest.created"
}
Guest Updated Notification
This webhook notification is sent whenever an existing Guest record is altered within your Guesty account. Learn how to create this webhook here.
Notification Payload
| Body Parameter | Data Type | Description |
|---|---|---|
guest | object | The altered guest record. |
by | string | The source of the alteration. |
event | string | guest.updated |
Guest Updated Notification Example
{
"guest":{
"airbnb":{
"id":88419363516114
},
"airbnb2":{
"index":"index",
"id":88419363628340
},
"policy":{
"marketing":{
"isAccepted":false,
"dateOfAcceptance":null
},
"termsAndConditions":{
"isAccepted":false
}
},
"verifications":[
],
"emails":[
"[email protected]"
],
"phones":[
"12016665626"
],
"communicationMethods":[
"email",
"sms"
],
"paymentMethodIds":[
],
"interests":[
],
"allergies":[
],
"dietaryPreferences":[
],
"tags":[
],
"_id":"6310a0759dcce60032e95a6c",
"firstName":"Gerald",
"lastName":"Charlton",
"email":"[email protected]",
"accountId":"62a8a2be2e53190032102a6e",
"pictures":[
],
"paymentProvidersCustomers":[
],
"fullName":"Gerald Charlton",
"phone":"12016665626",
"__v":1,
"hometown":"Santiago"
},
"guestBefore":{
"airbnb":{
"id":88419363516114
},
"airbnb2":{
"index":"index",
"id":88419363628340
},
"policy":{
"marketing":{
"isAccepted":false,
"dateOfAcceptance":null
},
"termsAndConditions":{
"isAccepted":false
}
},
"verifications":[
],
"emails":[
"[email protected]"
],
"phones":[
"12016665626"
],
"communicationMethods":[
"email",
"sms"
],
"paymentMethodIds":[
],
"interests":[
],
"allergies":[
],
"dietaryPreferences":[
],
"tags":[
],
"_id":"6310a0759dcce60032e95a6c",
"firstName":"Gerald",
"lastName":"Charlton",
"email":"[email protected]",
"accountId":"62a8a2be2e53190032102a6e",
"pictures":[
],
"paymentProvidersCustomers":[
],
"fullName":"Gerald Charlton",
"phone":"12016665626",
"__v":0
},
"by":"[email protected]",
"event":"guest.updated"
}
Guest Deleted Notification
This webhook notification is sent whenever an existing Guest record is deleted within your Guesty account. Learn how to create this webhook here.
Notification Payload
| Body Parameter | Data Type | Description |
|---|---|---|
guest | object | The deleted guest record. |
by | string | The source of the deletion. |
event | string | guest.deleted |
Guest Deleted Notification Example
{
"guest":{
"airbnb":{
"id":88419363516114
},
"airbnb2":{
"index":"index",
"id":88419363628340
},
"policy":{
"marketing":{
"isAccepted":false,
"dateOfAcceptance":null
},
"termsAndConditions":{
"isAccepted":false
}
},
"verifications":[
],
"emails":[
"[email protected]"
],
"phones":[
"12016665626"
],
"communicationMethods":[
"email",
"sms"
],
"paymentMethodIds":[
],
"interests":[
],
"allergies":[
],
"dietaryPreferences":[
],
"tags":[
],
"_id":"6310a0759dcce60032e95a6c",
"firstName":"Gerald",
"lastName":"Charlton",
"email":"[email protected]",
"accountId":"62a8a2be2e53190032102a6e",
"pictures":[
],
"paymentProvidersCustomers":[
],
"fullName":"Gerald Charlton",
"phone":"12016665626",
"__v":1,
"hometown":"Santiago"
},
"by":"[email protected]",
"event":"guest.deleted"
}
Updated 5 months ago