Webhooks Overview
Webhooks can be used to notify your application when a milestone event happens in your account. Webhooks can be turned on/off, tested, and configured in Settings. When a milestone event occurs, you will receive a notification to your designated endpoint URL. All notification data is sent in JSON format. By using webhooks, you are agreeing to our Terms of Use.
Webhook Requests
NOTE: This option is available to
Customer users.
For each event occurrence that you are setup to receive, the platform POSTs the webhook data to your endpoint in JSON format. To acknowledge receipt of an event, your endpoint must return a 2xx HTTP status code. All response codes outside this range indicate to the platform that you did not receive the event. Because properly acknowledging receipt of the webhook notification is so important, your endpoint should return a 2xx HTTP status code prior to any complex logic that could cause a timeout.
Additional notes:
- The platform returns the name of the webhook event in each event's event_type header.
- The platform returns your Webhook Secret in each event's webhook_secret header - use this value to verify the source of the request.
Repair Order Events
NOTE: This option is available to
Customer users.
The platform can be configured to send webhooks on any/all of the events below when they occur within the UI (note that these events are NOT triggered when creating/modifying repair orders via API):
- ro.created - this event occurs when a repair order is created.
- ro.started - this event occurs when a repair order is started.
- ro.expected_updated - this event occurs when the Expected Finish date is modified (if the Expected Finish is modified while starting the repair order, only ro.started will be triggered).
- ro.waiting - this event occurs if a repair order is waiting for approval.
- ro.finished - this event occurs when a repair order is finished.
- ro.finished_undo - this event occurs when a repair order finish is undone.
- ro.invoiced - this event occurs when a repair order is invoiced.
- ro.invoiced_undo - this event occurs when a repair order invoice is undone.
- ro.deleted - this event occurs when a repair order is deleted.
- ro.total_updated - this event occurs whenever the grand total on a repair order changes.
- ro.notes_updated - this event occurs whenever a repair order note is added, modified, or deleted.
Event Payload:
Purchase Order Events
NOTE: This option is available to
Customer users.
The platform can be configured to send webhooks on any/all of the events below when they occur within the UI (note that these events are NOT triggered when creating/modifying purchase orders via API):
- po.created - this event occurs when a purchase order is created.
- po.opened - this event occurs when a purchase order is opened.
- po.opened_undo - this event occurs when a purchase order open is undone.
- po.received - this event occurs when inventory on a purchase order is received.
- po.received_undo - this event occurs when undoing received inventory.
- po.closed - this event occurs when a purchase order is closed.
- po.closed_undo - this event occurs when a purchase order close is undone.
- po.deleted - this event occurs when a purchase order is deleted.
Event Payload:
Unit Events
NOTE: This option is available to
Customer users.
The platform can be configured to send webhooks on any/all of the events below:
- unit.group_updated - this event occurs when a unit's group is modified.
- unit.status_updated - this event occurs when a unit's status is modified.
- unit.tag_updated - this event occurs when a unit's tag(s) are modified.
- unit.custom_data_updated - this event occurs when a unit's custom data is modified.
Event Payload:
- The event payload will be in the same format as the Get Units API response.
Scheduled Maintenance Events
NOTE: This option is available to
Customer users.
The platform can be configured to send webhooks on any/all of the events below:
- sch_maint.due - this event occurs daily, and provides a list of all scheduled maintenance that is almost due and/or overdue (overdue scheduled maintenance will will have a value in the "became_due" element).
Event Payload: