The following events are available for the Forms API. To set up automation based on these events, create a webhook using the Webhooks API.
content
, eventType
, enqueuedDateTime
, iTwinId
, messageId
, and webhookId
. The content
will vary based on what event has been received. See below for a list of properties included inside the content for each event type.Event content.
Date and time when event was enqueued.
iTwin Id.
Event message Id.
Webhook Id.
{ "content": { // event specific properties go here }, "eventType": "api.action.version", "Base Event eventType":"base-event-eventType", "enqueuedDateTime":"string", "iTwinId":"string", "messageId":"string", "webhookId":"string" }
The globally unique identifier of the attachment.
The globally unique identifier of the form data the attachment became attached to.
The discipline of the data instance the attachment became unattached to.
{ "content": { "attachmentId":"07373b30-52ce-4b4d-8af6-b7dd0a68c29c", "formId":"89f14044-47f3-4252-adcb-c75ed4b2a1b2", "discipline":"General Purpose" }, "eventType": "forms.attachmentAttached.v1", "Base Event eventType":"undefined", "enqueuedDateTime":"11/3/2023 8:07:01 PM", "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9", "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b", "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493" }
The globally unique identifier of the attachment.
The globally unique identifier of the form data the attachment was unattached from.
The discipline of the data instance the attachment became unattached from.
{ "content": { "attachmentId":"07373b30-52ce-4b4d-8af6-b7dd0a68c29c", "formId":"89f14044-47f3-4252-adcb-c75ed4b2a1b2", "discipline":"General Purpose" }, "eventType": "forms.attachmentUnattached.v1", "Base Event eventType":"undefined", "enqueuedDateTime":"11/3/2023 8:07:01 PM", "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9", "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b", "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493" }
The globally unique identifier of the comment.
The globally unique identifier of the form data the comment was created for.
The discipline of the data instance the comment was created for.
{ "content": { "commentId":"969a8e68-07b8-47da-bf65-74a3c71a8c47", "formId":"89f14044-47f3-4252-adcb-c75ed4b2a1b2", "discipline":"General Purpose" }, "eventType": "forms.commentCreated.v1", "Base Event eventType":"undefined", "enqueuedDateTime":"11/3/2023 8:07:01 PM", "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9", "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b", "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493" }
Denotes what file or iModel element the data instance was created about. Will be null if not applicable.
The globally unique identifier of the form data that was created.
The discipline of this data instance.
{ "content": { "sourceEntityId":"f9e89f85-ad02-4043-93eb-71f2e2b2a427", "formId":"89f14044-47f3-4252-adcb-c75ed4b2a1b2", "discipline":"General Purpose" }, "eventType": "forms.formCreated.v1", "Base Event eventType":"undefined", "enqueuedDateTime":"11/3/2023 8:07:01 PM", "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9", "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b", "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493" }
Denotes what file or iModel element the data instance was created about. Will be null if not applicable.
The globally unique identifier of the form data that was deleted.
The discipline of this data instance.
{ "content": { "sourceEntityId":"f9e89f85-ad02-4043-93eb-71f2e2b2a427", "formId":"89f14044-47f3-4252-adcb-c75ed4b2a1b2", "discipline":"General Purpose" }, "eventType": "forms.formDeleted.v1", "Base Event eventType":"undefined", "enqueuedDateTime":"11/3/2023 8:07:01 PM", "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9", "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b", "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493" }
Denotes what file or iModel element the data instance was created about. Will be null if not applicable.
The globally unique identifier of the form data that was updated.
The discipline of this data instance.
{ "content": { "sourceEntityId":"f9e89f85-ad02-4043-93eb-71f2e2b2a427", "formId":"89f14044-47f3-4252-adcb-c75ed4b2a1b2", "discipline":"General Purpose" }, "eventType": "forms.formUpdated.v1", "Base Event eventType":"undefined", "enqueuedDateTime":"11/3/2023 8:07:01 PM", "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9", "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b", "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493" }
The globally unique identifier of the external file instance that was linked. Will generally consist of ES_
followed by a GUID.
The globally unique identifier of the form data the external file was linked to.
The discipline of the data instance the external file was linked to.
{ "content": { "fileId":"ES_41070fc0-9375-4b8a-84bf-e41d0ded68f8", "formId":"89f14044-47f3-4252-adcb-c75ed4b2a1b2", "discipline":"General Purpose" }, "eventType": "forms.externalFileLinked.v1", "Base Event eventType":"undefined", "enqueuedDateTime":"11/3/2023 8:07:01 PM", "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9", "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b", "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493" }
The globally unique identifier of the external file instance that was unlinked. Will generally consist of ES_
followed by a GUID.
The globally unique identifier of the form data the external file was unlinked from.
The discipline of the data instance the external file was unlinked from.
{ "content": { "fileId":"ES_41070fc0-9375-4b8a-84bf-e41d0ded68f8", "formId":"89f14044-47f3-4252-adcb-c75ed4b2a1b2", "discipline":"General Purpose" }, "eventType": "forms.externalFileUnlinked.v1", "Base Event eventType":"undefined", "enqueuedDateTime":"11/3/2023 8:07:01 PM", "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9", "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b", "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493" }
The globally unique identifier of the form metadata instance.
The discipline of the related data instance.
{ "content": { "metadataId":"f2510d7d-1cc2-47b6-bc15-0c984b8c8466", "discipline":"General Purpose" }, "eventType": "forms.metadataDeleted.v1", "Base Event eventType":"undefined", "enqueuedDateTime":"11/3/2023 8:07:01 PM", "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9", "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b", "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493" }
Was this page helpful?