Events
Below are a list of the events that you can subscribe to.
CAPTUR3D triggers webhooks based on the following events when they occur in your CAPTUR3D account.
Our events typically follow a <resource>.<action> format
Events
property.created
Triggered any time a new Property is created within your Captur3d account. Properties are a central resource in CAPTUR3D and many actions can facilitate the creation of a new Property.
e.g. Creating a Virtual Tour, ordering a Floor Plan, scheduling a booking, creating a photo retouching order, etc
Example payload:
{
"type": "property.created",
"created": "2025-02-13T13:31:07+11:00",
"version": "1.0",
"data": {
"id": 42,
"display_name": "101 Collins Street",
"external_reference": "your application's reference",
"property_type": "residential",
"created_at": "2025-02-10T01:38:47.305Z",
"updated_at": "2025-02-10T01:38:47.305Z",
"address": {
"country": "Australia",
"latitude": 3.14,
"longitude": 3.14,
"postcode": "3000",
"state": "Victoria",
"street_address": "101 Collins Street",
"suburb": "Melbourne"
},
"client": {
"id": 42,
"name": "My Client X"
}
}
}floor_plan_order.completed
Triggered when a Floor Plan order has been completed by our designers.
Example payload:
{
"type": "floor_plan_order.completed",
"created": "2025-02-13T13:31:07+11:00",
"version": "1.0",
"data": {
"order_id": 42,
"property_id": 42,
"status": "completed",
"external_id": "your application's reference",
"issues": [
"The position of your property was not clear on satellite maps, so we were unable to add a north compass to your Floor Plan."
],
"floor_plans": [
{
"id": 42,
"name": "floorplan.png",
"url": "https://some-url.com/image/file.png"
}
]
}
}floor_plan_order.amended
Triggered after an amendment to a Floor Plan order has been completed by our designers.
Example payload:
{
"type": "floor_plan_order.amended",
"created": "2025-02-13T13:31:07+11:00",
"version": "1.0",
"data": {
"order_id": 42,
"original_order_id": 41,
"property_id": 123,
"status": "completed",
"external_id": "Your application's reference",
"issues": [],
"floor_plans": [
{
"id": 42,
"name": "updated-floorplan.png",
"url": "https://some-url.com/image/updated-file.png"
}
]
}
}floor_plan_template_order.completed
Triggered when a custom template order has been completed by our designers.
{
"type": "floor_plan_template_order.completed",
"created": "2025-02-13T13:31:07+11:00",
"version": "1.0",
"data": {
"order_id": 42,
"name": "My Custom Template #1",
"status": "completed",
"external_id": "your application's reference",
"preview_image_url": "https://some-url.com/image/file.png",
"template_id": 123,
"tags": ["2d", "custom"]
}
}floor_plan_template_order.cancelled
Triggered when a custom template order can not be processed by our designers.
{
"type": "floor_plan_template_order.cancelled",
"created": "2025-02-13T13:31:07+11:00",
"version": "1.0",
"data": {
"order_id": 42,
"name": "My Custom Template #1",
"status": "cancelled",
"external_id": "your application's reference",
"cancelled_at": "2025-02-14T13:31:07+11:00",
"cancellation_reason": "The files you provided were incomplete"
}
}post_production_order.completed
Triggered when Post Production updates have been completed by our tour specialists.
Example payload:
{
"type": "post_production_order.completed",
"created": "2025-02-13T13:31:07+11:00",
"version": "1.0",
"data": {
"property_id": 123,
"status": "completed",
"matterport_model_key": "abcdefghijk",
"scan_time": "2019-12-15T09:32:45Z",
"floor_plan_requested": true,
"model_optimisation_requested": true,
"virtual_tour_requested": true
}
}Need a different event?
As developers, we understand that you might have a use case which requires a different event to trigger a webhook. Please do not hesitate to get in touch with us to request new events be added.