Register webhooks and let Hostfully call you back based on specific triggered events
This API allows Hostfully tech partner to register webhooks and have their system called back when specific events are triggered on Hostfully for specific entities.
For example, a partner may want to be notified every time a new booking happens for a specific property or a specific agency. Or a partner want to be notified when a specific property is being updated.
Supported event types
The following event types are supported:
- NEW_INQUIRY
- NEW_BOOKING
- NEW_PROPERTY
- UPDATED_PROPERTY
- DELETED_PROPERTY
- DEACTIVATED_PROPERTY
- BOOKING_CANCELLED
- BOOKING_UPDATED
- CHANNEL_ACTIVATED
- CHANNEL_DEACTIVATED
- PINCODE_CREATED
- PINCODE_DELETED
- INTEGRATION_ACTIVATED
- INTEGRATION_DEACTIVATED
Format of the callbacks
When Hostfully detects a event for which a webhook has been registered, our system will perform a callback to your URL and will send data via a HTTP POST. The following data will be send in the body of the POST call:
- agency_uid: the uid of the agency associated with the monitored object
- event_type: the type of event for which this callback is being performed
Optional data:
- property_uid: if the object monitored is a property, the property UID will be provided
- lead_uid: if the event type is related to bookings or inquiries, the lead UID will be provided
Integration Events:
For events of type INTEGRATION_ACTIVATED and INTEGRATION_DEACTIVATED, just pass the affiliate ID (your API key) as the value for the objectUid parameter. The returned payload will just include the "agency_uid" (unique ID of the agency which activated the integration).