Webhook Event Types
Intro
Webhook events will be sent to your callback url whenever specific that specific event occurs within your Fieldwire projects. This document aims to provide a guide on the expected data from that webhook event.
Event Schema:
Below is a the schema of events that will be sent via Post requests:
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://example.com/product.schema.json",
"title": "Event",
"description": "Fieldwire Event",
"type": "object",
"properties": {
"schema_version": {
"description": "Version of the event Schema",
"type": "string"
},
"event_category": {
"description": "Category of the event type, can be either project or account. Defines event's scope",
"type": "string"
},
"entity_id": {
"description": "Id of the entity that was modified",
"type": "string"
},
"event_id": {
"description": "Id of the Event",
"type": "string"
},
"event_timestamp": {
"description": "Time stamp of the event",
"type": "integer"
},
"account_id": {
"description": "account Id of the Event, can't be null",
"type": "integer"
},
"project_id": {
"description": "Project Id of the Event, can be null",
"type": "string"
},
"user_id": {
"description": "User Id related to the event, can be null or some other Id of automation",
"type": "integer"
},
"event": {
"type": "object",
"properties": {
"entity_type":{
"description": "entity type",
"type": "string"
},
"action":{
"description": "action type",
"type": "string"
},
"attributes":{
"description": "Attributes for the event",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"entity_data": {
"description": "Data about the entity that was modified",
"type": "object"
}
},
"required": [ "schema_version", "event_category", "event_id", "event_timestamp", "event", "account_id" ]
}
Example event
Below is a example event triggered when attachment has been merged
{
"schema_version": "1.0.0",
"event_category": "project",
"event_id": "b781b17f-c48a-4409-b225-bc828c91f42a",
"event_timestamp": 1677270335,
"account_id": 1,
"project_id": "bbe49ae9-b609-4c1c-be40-e954705fcd66",
"user_id": 793065,
"event": {
"entity_type": "attachment",
"action": "merged",
"attributes": null
},
"entity": {
"id": "b4508313-de34-4ad5-860a-228172d49b2c",
"project_id": "bbe49ae9-b609-4c1c-be40-e954705fcd66",
"creator_user_id": 793065,
"name": "JPG file.jpg",
"thumb_url": null,
"file_url": "https://d33htgqikc2pj4.cloudfront.net/qvHDimMUqxZcQnsj/4FnN7TjQMe37TAgWtJRw_JPG file.jpg",
"deleted_at": null,
"device_created_at": "2023-02-24T20:25:35.535Z",
"device_updated_at": "2023-02-24T20:25:35.535Z",
"created_at": "2023-02-24T20:25:35.536Z",
"updated_at": "2023-02-24T20:25:35.537Z",
"file_size": 4230050,
"kind": "file",
"is_dynamic": false,
"folder_id": "6733fed3-6fa9-4870-ad9e-33dc604f1b36",
"last_editor_user_id": 793065,
"sync_id": null,
"content_hash": null,
"sync_path": null,
"floorplans_count": 0,
"original_url": "https://s3.amazonaws.com/tsvabqmdcirbjnxq/qvHDimMUqxZcQnsj/4FnN7TjQMe37TAgWtJRw_JPG file.jpg",
"process_state": null,
"cascade_deleted_by_id": null,
"cascade_deleted_by_type": null,
"latitude": null,
"longitude": null,
"sync_last_pushed_at": null,
"sync_modified_content_last_pushed_at": null,
"file_url_uuid": "31338eb4-edf5-45a5-8943-4a89a66e9834",
"original_url_uuid": "4c8afa0c-d3b2-4f14-bee4-e6fac28d2431",
"thumb_url_uuid": null,
"has_private_urls": false,
"flattened_file_url": null,
"flattened_file_url_uuid": null,
"reindexed_ess_at": null,
"visibility_permission": "project_files_visible",
"override_updated_at": false,
"deleted_by_two_way_sync": false,
"migrated_from_bubble_id": null
}
}
Event Types:
This list is subject to change
Each Fieldwire entity below is supported for notification. Each entity has a select number of event types that it supports.
"entity_type":{
"description": "entity type",
"type": "string"
}
You can identify the entity and the event type from the above JSON snippet.
Entity Type | Supported Events |
---|---|
Attachments | created, updated, deleted, restored |
Entity Tags | created, updated, deleted |
Entity Taggings | created, deleted |
Floorplans | created, updated, deleted, merged, rescanned, rotated |
Forms | created, updated, deleted |
Hyperlinks | created, updated, deleted, restored |
Markups | created, updated, deleted, restored |
Multi-Hyperlinks | created, updated, deleted, restored |
Project | created, updated, deleted, transferred |
Project Resource Link | created, updated, deleted, restored |
Project Users | created, updated, deleted |
Sheet | created, updated, deleted |
Sheet Upload | created |
Task* | created, updated, deleted |
Task check Item | created, updated, deleted |
Task Relation | created |
*Note: Updates to custom task attributes are not included as task update events
Updated about 1 month ago