update.required webhook

📘

Please read the Webhooks section before

{
  "external_id": str
}

Overview

The update.required webhook is a crucial component of our integration with partners, mandated for implementation. This webhook empowers Livble to send on-demand requests to partners, prompting the refresh of portal data for a specific tenant. Its implementation is essential for maintaining the accuracy and timeliness of tenant data within the system.

Purpose and Use Cases

This webhook serves several critical functions, including:

• On-Demand Troubleshooting: Enables Livble and partners to quickly resolve issues by requesting up-to-date tenant information.
• Data Quality Assurance: Ensures that the tenant information within Livble's system remains accurate and current, enhancing service reliability.
• Support for Autopay Features: Facilitates the smooth operation of Livble's autopay system by ensuring it operates with the latest tenant data.

Required Action upon Receiving the Webhook

Upon receipt of the update.required webhook, partners are required to:

1. Initiate a Data Refresh: Perform a POST /portal_info request to Livble's API. This action mirrors the process used for obtaining a tenant token, thereby updating Livble with the latest tenant portal information.

Implementation Requirement

Implementing the update.required webhook is not optional; it is a mandatory requirement for all Livble partners. This implementation is critical for ensuring that both Livble and its partners can provide tenants with the most reliable and effective service possible.

Support and Compliance

We understand that implementing new webhooks can be a complex process, which is why our team is ready to offer support and guidance every step of the way. Compliance with this mandatory webhook ensures that our integrated systems can continue to operate efficiently and effectively, benefiting both our partners and the tenants we serve.