A webhook is a means of notifying a third-party application of the occurrence of an event with some relevant information. In the ButterflyMX API, webhooks are currently triggered by the following resources:

  • Door release
  • Call

Webhook Notification Object

A notification object contains the following fields:

AttributeTypeDescription
idnumberThe ButterflyMX defined id representing the Webhooks notification.
panel_idnumberThe ButterflyMX defined id representing the panel.
release_methodstringCorresponds to a release method.