Webhook

A Webhook is a service configuration in Yonomi Platform used to allow Yonomi Platform to send device and service-related events and data directly to PACS Partners for processing. Webhooks are means by which Yonomi Platform dispatches real-time device state changes and other event notifications to PACS Partners. ​

PACS Partners create and configure webhooks in the YP Developer Portal as a component of a Dev Resource Group by supplying an API endpoint that will be used to capture data sent by Yonomi Platform anytime a device state changes, or any other event emits. ​

Subscriptions are configured by associating a webhook with an Integration and selecting the events to which the PACS Partner wants to subscribe. ​

Event types include:​

• Device State Updated (such as a lock state change from “locked” to “unlocked”)
• Device Action Created (such as a request to change a lock’s state from “locked“ to “unlocked“)
• Device Action Updated (such as the status of the action request being fulfilled successfully)
• Device Notification Reported (such as critical battery level notification)

Webhook events occur in real-time – they are sent from YP over the webhook immediately upon the state of a device changing or action being requested.

Retries

If the webhook endpoint returns a non-2xx response code, Yonomi retries failed webhook deliveries. Webhooks are delivered via AWS SNS HTTPS subscriptions using the default delivery policy: 3 retries after the initial attempt, with a 20-second delay between each attempt (linear backoff). There is a maximum of 4 total delivery attempts. If all attempts fail, the event is not recoverable.