To better support our partners in integrating their services via API and sending key data back to the Hostex system, we have enabled Custom Fields functionality in the order interface.
Use Case Example
More and more service providers are integrating with our platform via API. Some, such as smart lock providers, wish to send back data like generated lock codes so that Hostex users can view and use them directly in the system.
To support this, we allow partners to read and update custom fields related to an order using the following API endpoints:
Usage in Automated Messages
Since the most common use case for custom fields is referencing them in automation message templates, we provide a shortcode auto-mapping mechanism.
Once a custom field is set (e.g., my_lockcode), it can be directly referenced in automation messages using the following syntax:{{cf.my_lockcode}}
Simply prefix the field name with cf., and the value will be automatically injected into the message — no additional configuration is required.