Webhooks: Guests

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?

Guesty sends guest notifications for the following events:

Creation of a new guest record.
An existing guest record is updated.
Deletion of a guest record.

Why Create Guest Webhooks?

Once your Guesty Open API integration is complete and finished with its initial data synchronization, we recommend you utilize the guests webhooks. Webhooks will help you save time and resources. Plus, you get to synchronize only 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 is sent whenever a new Guest is created within your Guesty account. Learn how to subscribe to this webhook here.

Webhook to Subscribe

guest.created

Webhook Payload

Body Parameter	Data Type	Description
`guest`	object	The new guest record.
`by`	string	The source of new Guest record.
`event`	string	`guest.created`

Payload 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 is sent whenever an existing Guest record is altered within your Guesty account. Learn how to subscribe to this webhook here.

Webhook to Subscribe

guest.updated

Webhook Payload

Body Parameter	Data Type	Description
`guest`	object	The altered guest record.
`by`	string	The source of the alteration.
`event`	string	`guest.updated`

Payload 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 is sent whenever an existing Guest record is deleted within your Guesty account. Learn how to subscribe to this webhook here.

Webhook to Subscribe

guest.deleted

Webhook Payload

Body Parameter	Data Type	Description
`guest`	object	The deleted guest record.
`by`	string	The source of the deletion.
`event`	string	`guest.deleted`

Payload 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"
}