API Reference

Event Triggers

Webhook events are triggered by changes to an order. The event name indicates the most recent change that occurred. Certain events are considered more important than others and may require immediate action from an automation or manual input from a team member on your end. We have provided a set of recommended events that we believe are necessary for the success of an integration. Additional events can be added to your subscription too.

👍

Recommended Events

Recommended events come with a and generally indicate some new piece of data is available. Click learn more in their descriptions for details on the new data that can be found in the webhook payload.

Order Event Triggers

Event

Description

Recommeneded

appointment.scheduled

An appointment has been scheduled. Details about the date and time are now available. Learn more.

order.delivered

The order's assets are ready for download and links to them can be found in the webhook payload. Learn more

appointment.unable_to_complete

The PlanOtech was unable to complete the order because the property wasn't ready. Learn more

order.canceled

On rare occasion, PlanOmatic may need to cancel if the property is out of range of a service area. Learn more

order.processed

The order requested has been successfully processed.

appointment.awaiting_availability

The property were the order was requested has limited availability.

appointment.awaiting_reschedule

A new appointment is in the process of being scheduled.

order.post_processing

The assets ordered are being processed by our production team.