Available Events - Webhooks

Webhooks

Download API definition:

Available Events

All events sent to the callback url will be in the body of a POST request. This post request will contain properties that will be included on every request, regardless of event type. These include 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.

The following is an example of what will be received for an event.

Properties

content

Object

Event content.

iTwinId

String

iTwin Id.

eventType

String

Webhook event type.

messageId

String

Event message Id.

webhookId

String

Webhook Id.

enqueuedDateTime

String

Date and time when event was enqueued.

Example

JSON

{
    "content": {
      // event specific properties go here    
    },
    "eventType": "api.action.version",
    "iTwinId":"string",
    "messageId":"string",
    "webhookId":"string",
    "enqueuedDateTime":"string"
}

Access Control Events

Event that gets triggered when a member is added to an iTwin.

Properties

roleId

String

Globally Unique Identifier of the role the member was assigned.

memberId

String

Globally Unique Identifier of the member.

roleName

String

Name of the role the member was assigned.

memberType

String

Type of member.

eventCreatedBy

String

Globally Unique Identifier of the user added the member.

Example

JSON

{
   "content": {
        "roleId":"d42d3349-1117-41cb-b2c4-7afff1f80d23",
        "memberId":"e5c7ae4f-2d72-4319-b96a-d46492e4f860",
        "roleName":"Viewer",
        "memberType":"User",
        "eventCreatedBy":"6411cfcf-d188-4788-9267-43eb0f208c8e"
    },
    "eventType": "accessControl.memberAdded.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when a role is assigned to a member.

Properties

roleId

String

Globally Unique Identifier of the role the member was assigned.

memberId

String

Globally Unique Identifier of the member.

roleName

String

Name of the role the member was assigned.

memberType

String

Type of member.

eventCreatedBy

String

Globally Unique Identifier of the user who assigned the role.

Example

JSON

{
   "content": {
        "roleId":"d42d3349-1117-41cb-b2c4-7afff1f80d23",
        "memberId":"e5c7ae4f-2d72-4319-b96a-d46492e4f860",
        "roleName":"Viewer",
        "memberType":"User",
        "eventCreatedBy":"6411cfcf-d188-4788-9267-43eb0f208c8e"
    },
    "eventType": "accessControl.roleAssigned.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when a member is removed from an iTwin.

Properties

memberId

String

Globally Unique Identifier of the member.

memberType

String

Type of member.

eventCreatedBy

String

Globally Unique Identifier of the user who removed the member.

Example

JSON

{
   "content": {
        "memberId":"e5c7ae4f-2d72-4319-b96a-d46492e4f860",
        "memberType":"User",
        "eventCreatedBy":"6411cfcf-d188-4788-9267-43eb0f208c8e"
    },
    "eventType": "accessControl.memberRemoved.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when a role is unassigned to a member.

Properties

roleId

String

Globally Unique Identifier of the role the member was assigned.

memberId

String

Globally Unique Identifier of the member.

roleName

String

Name of the role the member was assigned.

memberType

String

Type of member.

eventCreatedBy

String

Globally Unique Identifier of the user who unassigned the role.

Example

JSON

{
   "content": {
        "roleId":"d42d3349-1117-41cb-b2c4-7afff1f80d23",
        "memberId":"e5c7ae4f-2d72-4319-b96a-d46492e4f860",
        "roleName":"Viewer",
        "memberType":"User",
        "eventCreatedBy":"6411cfcf-d188-4788-9267-43eb0f208c8e"
    },
    "eventType": "accessControl.roleUnassigned.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event sent when an invitation is emailed to a user.

Properties

invitationId

String

Globally Unique Identifier of the invitation.

Example

JSON

{
   "content": {
        "invitationId":"00000000-0000-0000-0000-000000000000"
    },
    "eventType": "accessControl.invitationCreated.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Changed Elements Events

Event that gets triggered when a changed element comparison job is complete from the Changed Elements V2 API

Properties

jobId

String

Globally Unique Identifier of the changed element comparison job.

iModelId

String

Globally Unique Identifier of the iModel.

jobSucceeded

Boolean

Boolean flag indicating success or failure of the changed element comparison job.

Example

JSON

{
   "content": {
        "jobId":"9f5e8bb1-e3e1-4037-8d83-e08d6d07d9cc",
        "iModelId":"72640bf2-2173-4276-b896-c157bee0df76",
        "jobSucceeded":"true"
    },
    "eventType": "changedElements.jobCompleted.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when a changed element diff job is complete from the Changed Elements V3 API

Properties

jobId

String

Globally Unique Identifier of the changed element diff job.

iModelId

String

Globally Unique Identifier of the iModel.

jobSucceeded

Boolean

Boolean flag indicating success or failure of the changed element diff job.

diffingStrategy

String

The diffing strategy used for the changed element diff job.

Example

JSON

{
   "content": {
        "jobId":"9f5e8bb1-e3e1-4037-8d83-e08d6d07d9cc",
        "iModelId":"72640bf2-2173-4276-b896-c157bee0df76",
        "jobSucceeded":"true",
        "diffingStrategy":"Cesium"
    },
    "eventType": "changedElements.jobCompleted.v2",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Export Events

Event that gets triggered when a export job is complete

Properties

result

String

Result of the export

exportId

String

Globally Unique Identifier of the export.

iModelId

String

Globally Unique Identifier of the iModel.

connectionId

String

Identifier of the connection.

Example

JSON

{
   "content": {
        "result":"success",
        "exportId":"b1a1d87d-1aef-4a65-9baa-c747a382bf67",
        "iModelId":"72640bf2-2173-4276-b896-c157bee0df76",
        "connectionId":"MWplZe9Uf0iR1IDMqyOMLqBN0_wHEVBGg_CzJmXdmE4"
    },
    "eventType": "export.jobCompleted.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Forms Events

Event that gets triggered when a form data instance was created.

Properties

formId

String

The globally unique identifier of the form data that was created.

discipline

String

The discipline of this data instance.

sourceEntityId

String

Denotes what file or iModel element the data instance was created about. Will be null if not applicable.

Example

JSON

{
   "content": {
        "formId":"89f14044-47f3-4252-adcb-c75ed4b2a1b2",
        "discipline":"General Purpose",
        "sourceEntityId":"f9e89f85-ad02-4043-93eb-71f2e2b2a427"
    },
    "eventType": "forms.formCreated.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when a form data instance was deleted.

Properties

formId

String

The globally unique identifier of the form data that was deleted.

discipline

String

The discipline of this data instance.

sourceEntityId

String

Denotes what file or iModel element the data instance was created about. Will be null if not applicable.

Example

JSON

{
   "content": {
        "formId":"89f14044-47f3-4252-adcb-c75ed4b2a1b2",
        "discipline":"General Purpose",
        "sourceEntityId":"f9e89f85-ad02-4043-93eb-71f2e2b2a427"
    },
    "eventType": "forms.formDeleted.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when a form data instance was modified.

Properties

formId

String

The globally unique identifier of the form data that was updated.

discipline

String

The discipline of this data instance.

sourceEntityId

String

Denotes what file or iModel element the data instance was created about. Will be null if not applicable.

Example

JSON

{
   "content": {
        "formId":"89f14044-47f3-4252-adcb-c75ed4b2a1b2",
        "discipline":"General Purpose",
        "sourceEntityId":"f9e89f85-ad02-4043-93eb-71f2e2b2a427"
    },
    "eventType": "forms.formUpdated.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when a comment was created for a particular form data instance.

Properties

formId

String

The globally unique identifier of the form data the comment was created for.

commentId

String

The globally unique identifier of the comment.

discipline

String

The discipline of the data instance the comment was created for.

Example

JSON

{
   "content": {
        "formId":"89f14044-47f3-4252-adcb-c75ed4b2a1b2",
        "commentId":"969a8e68-07b8-47da-bf65-74a3c71a8c47",
        "discipline":"General Purpose"
    },
    "eventType": "forms.commentCreated.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when a form metadata instance (that is, a `Forms_EC_Mapping/Form` instance which groups together one or more FormDefinitions) was deleted.

Properties

discipline

String

The discipline of the related data instance.

metadataId

String

The globally unique identifier of the form metadata instance.

Example

JSON

{
   "content": {
        "discipline":"General Purpose",
        "metadataId":"f2510d7d-1cc2-47b6-bc15-0c984b8c8466"
    },
    "eventType": "forms.metadataDeleted.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when an attachment instance became attached (related) to a form data instance.

Properties

formId

String

The globally unique identifier of the form data the attachment became attached to.

discipline

String

The discipline of the data instance the attachment became unattached to.

attachmentId

String

The globally unique identifier of the attachment.

Example

JSON

{
   "content": {
        "formId":"89f14044-47f3-4252-adcb-c75ed4b2a1b2",
        "discipline":"General Purpose",
        "attachmentId":"07373b30-52ce-4b4d-8af6-b7dd0a68c29c"
    },
    "eventType": "forms.attachmentAttached.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when an external file instance became linked (related) to a form data instance .

Properties

fileId

String

The globally unique identifier of the external file instance that was linked. Will generally consist of ES_ followed by a GUID.

formId

String

The globally unique identifier of the form data the external file was linked to.

discipline

String

The discipline of the data instance the external file was linked to.

Example

JSON

{
   "content": {
        "fileId":"ES_41070fc0-9375-4b8a-84bf-e41d0ded68f8",
        "formId":"89f14044-47f3-4252-adcb-c75ed4b2a1b2",
        "discipline":"General Purpose"
    },
    "eventType": "forms.externalFileLinked.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when an attachment is unattached from a form.

Properties

formId

String

The globally unique identifier of the form data the attachment was unattached from.

discipline

String

The discipline of the data instance the attachment became unattached from.

attachmentId

String

The globally unique identifier of the attachment.

Example

JSON

{
   "content": {
        "formId":"89f14044-47f3-4252-adcb-c75ed4b2a1b2",
        "discipline":"General Purpose",
        "attachmentId":"07373b30-52ce-4b4d-8af6-b7dd0a68c29c"
    },
    "eventType": "forms.attachmentUnattached.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when an external file instance became unlinked from a form data instance . (This means the relationship between the two was deleted, but the external file itself may or may not have been deleted).

Properties

fileId

String

The globally unique identifier of the external file instance that was unlinked. Will generally consist of ES_ followed by a GUID.

formId

String

The globally unique identifier of the form data the external file was unlinked from.

discipline

String

The discipline of the data instance the external file was unlinked from.

Example

JSON

{
   "content": {
        "fileId":"ES_41070fc0-9375-4b8a-84bf-e41d0ded68f8",
        "formId":"89f14044-47f3-4252-adcb-c75ed4b2a1b2",
        "discipline":"General Purpose"
    },
    "eventType": "forms.externalFileUnlinked.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Issues Events

Event that gets triggered when an issue was created.

Properties

issueId

String

The globally unique identifier of the issue that was created.

sourceEntityId

String

Denotes what file or iModel element the data instance was created about. Will be null if not applicable.

Example

JSON

{
   "content": {
        "issueId":"89f14044-47f3-4252-adcb-c75ed4b2a1b2",
        "sourceEntityId":"f9e89f85-ad02-4043-93eb-71f2e2b2a427"
    },
    "eventType": "issues.issueCreated.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when an issue was deleted.

Properties

issueId

String

The globally unique identifier of the issue that was deleted.

sourceEntityId

String

Denotes what file or iModel element the data instance was created about. Will be null if not applicable.

Example

JSON

{
   "content": {
        "issueId":"89f14044-47f3-4252-adcb-c75ed4b2a1b2",
        "sourceEntityId":"f9e89f85-ad02-4043-93eb-71f2e2b2a427"
    },
    "eventType": "issues.issueDeleted.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when an issue was modified.

Properties

issueId

String

The globally unique identifier of the issue that was updated.

sourceEntityId

String

Denotes what file or iModel element the data instance was created about. Will be null if not applicable.

Example

JSON

{
   "content": {
        "issueId":"89f14044-47f3-4252-adcb-c75ed4b2a1b2",
        "sourceEntityId":"f9e89f85-ad02-4043-93eb-71f2e2b2a427"
    },
    "eventType": "issues.issueUpdated.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when a comment was created for a particular issue instance.

Properties

issueId

String

The globally unique identifier of the issue the comment was created for.

commentId

String

The globally unique identifier of the comment.

Example

JSON

{
   "content": {
        "issueId":"89f14044-47f3-4252-adcb-c75ed4b2a1b2",
        "commentId":"969a8e68-07b8-47da-bf65-74a3c71a8c47"
    },
    "eventType": "issues.commentCreated.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when an issue metadata instance was deleted.

Properties

metadataId

String

The globally unique identifier of the issue metadata instance.

Example

JSON

{
   "content": {
        "metadataId":"f2510d7d-1cc2-47b6-bc15-0c984b8c8466"
    },
    "eventType": "issues.metadataDeleted.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when an attachment instance became attached (related) to an issue.

Properties

issueId

String

The globally unique identifier of the issue the attachment became attached to.

attachmentId

String

The globally unique identifier of the attachment.

Example

JSON

{
   "content": {
        "issueId":"89f14044-47f3-4252-adcb-c75ed4b2a1b2",
        "attachmentId":"07373b30-52ce-4b4d-8af6-b7dd0a68c29c"
    },
    "eventType": "issues.attachmentAttached.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when an external file instance became linked (related) to an issue.

Properties

fileId

String

The globally unique identifier of the external file instance that was linked. Will generally consist of ES_ followed by a GUID.

issueId

String

The globally unique identifier of the issue the external file was linked to.

Example

JSON

{
   "content": {
        "fileId":"ES_41070fc0-9375-4b8a-84bf-e41d0ded68f8",
        "issueId":"89f14044-47f3-4252-adcb-c75ed4b2a1b2"
    },
    "eventType": "issues.externalFileLinked.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when an attachment is unattached from an issue

Properties

issueId

String

The globally unique identifier of the issue the attachment was unattached from.

attachmentId

String

The globally unique identifier of the attachment.

Example

JSON

{
   "content": {
        "issueId":"89f14044-47f3-4252-adcb-c75ed4b2a1b2",
        "attachmentId":"07373b30-52ce-4b4d-8af6-b7dd0a68c29c"
    },
    "eventType": "issues.attachmentUnattached.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when an external file instance became unlinked from an issue. (This means the relationship between the two was deleted, but the external file itself may or may not have been deleted).

Properties

fileId

String

The globally unique identifier of the external file instance that was unlinked. Will generally consist of ES_ followed by a GUID.

issueId

String

The globally unique identifier of the issue the external file was unlinked from.

Example

JSON

{
   "content": {
        "fileId":"ES_41070fc0-9375-4b8a-84bf-e41d0ded68f8",
        "issueId":"89f14044-47f3-4252-adcb-c75ed4b2a1b2"
    },
    "eventType": "issues.externalFileUnlinked.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Reality Analysis Events

Event that gets triggered when a reality analysis job is complete

Properties

jobId

String

Globally Unique Identifier of the reality analysis job.

Example

JSON

{
   "content": {
        "jobId":"7f99b1a1-30cd-4f7b-8a4a-62d7f7f7b56a"
    },
    "eventType": "realityAnalysis.jobCompleted.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Reality Conversion Events

Event that gets triggered when a reality conversion job is complete

Properties

jobId

String

Globally Unique Identifier of the reality conversion job.

Example

JSON

{
   "content": {
        "jobId":"9f5e8bb1-e3e1-4037-8d83-e08d6d07d9cc"
    },
    "eventType": "realityConversion.jobCompleted.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Reality Modeling Events

Event that gets triggered when a reality modeling job is completed from the Reality Modeling V1 API

Properties

jobId

String

Globally Unique Identifier of the V1 reality modeling job.

Example

JSON

{
   "content": {
        "jobId":"79590d08-1281-418b-8920-e4413412884e"
    },
    "eventType": "realityModeling.jobCompleted.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when a reality modeling job is completed from the Reality Modeling V2 API

Properties

jobId

String

Globally Unique Identifier of the reality modeling job.

state

String

The state of the job. Either 'Cancelled', 'Failed', or 'Success'.

Example

JSON

{
   "content": {
        "jobId":"79590d08-1281-418b-8920-e4413412884e",
        "state":"Success"
    },
    "eventType": "realityModeling.jobCompleted.v2",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Synchronization Events

Event that gets triggered when a synchronization job is complete

Properties

result

String

Result of the synchronization

iModelId

String

Globally Unique Identifier of the iModel.

connectionId

String

Identifier of the connection.

synchronizationId

String

Globally Unique Identifier of the synchronization.

Example

JSON

{
   "content": {
        "result":"success",
        "iModelId":"72640bf2-2173-4276-b896-c157bee0df76",
        "connectionId":"MWplZe9Uf0iR1IDMqyOMLqBN0_wHEVBGg_CzJmXdmE4",
        "synchronizationId":"2ad03109-7c6a-47ef-88f6-d15f2a675529"
    },
    "eventType": "synchronization.jobCompleted.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Transformations Events

Event that gets triggered when a transformation job is complete

Properties

status

String

Status of the transformation

sourceITwinId

String

Globally Unique Identifier of the souce iTwin.

targetITwinId

String

Globally Unique Identifier of the target iTwin.

transformType

String

Type of transformation.

targetIModelId

String

Globally Unique Identifier of the target iModel.

configurationId

String

Globally Unique Identifier of the configuration.

transformationId

String

Globally Unique Identifier of the transformation.

Example

JSON

{
   "content": {
        "status":"Succeeded",
        "sourceITwinId":"99ff3a6a-26da-4313-ad6e-e2f3127afebe",
        "targetITwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
        "transformType":"MergeFork",
        "targetIModelId":"72640bf2-2173-4276-b896-c157bee0df76",
        "configurationId":"645030a1-c34e-435f-bb99-53dafd6d779e",
        "transformationId":"90c69811-1d4e-4bb8-a205-df4e98839c9e"
    },
    "eventType": "transformations.jobCompleted.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

iModels Events

Event that gets triggered when there are new changes to the iModel which are ready to be processed.

Properties

userId

String

Globally Unique Identifier of the user that iModel changeset belongs to.

imodelId

String

Globally Unique Identifier of the iModel.

changesetId

String

Changeset id is a 40 characters SHA1 hash that is used to validate Changeset. The id of Changeset is generated from the id of its parent as well as its contents.

changesetIndex

String

Index of the Changeset (increasing, but not necessarily sequential).

Example

JSON

{
   "content": {
        "userId":"e5c7ae4f-2d72-4319-b96a-d46492e4f860",
        "imodelId":"72640bf2-2173-4276-b896-c157bee0df76",
        "changesetId":"254c63645055a96d4a920425f5dfbc3adec5b602",
        "changesetIndex":"1"
    },
    "eventType": "iModels.changesReady.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when an iModel is cloned.

Properties

userId

String

Globally Unique Identifier of the user that cloned the iModel.

imodelId

String

Globally Unique Identifier of the iModel that was created.

sourceiTwinId

String

Globally Unique Identifier of the iTwin that the iModel was cloned from.

sourceimodelId

String

Globally Unique Identifier of the iModel that was cloned from.

clonedUpToChangesetId

String

The last changeset id that was included in the clone.

clonedUpToChangesetIndex

String

The last changeset index that was included in the clone.

Example

JSON

{
   "content": {
        "userId":"e5c7ae4f-2d72-4319-b96a-d46492e4f860",
        "imodelId":"0c651407-37d0-43bb-8c68-cb155cfc20b1",
        "sourceiTwinId":"20ceaf78-4f84-46e0-bf28-6e5c987a4aa2",
        "sourceimodelId":"20df82bd-5000-47ea-891f-690609eb4a3a",
        "clonedUpToChangesetId":"1",
        "clonedUpToChangesetIndex":"254c63645055a96d4a920425f5dfbc3adec5b602"
    },
    "eventType": "iModels.iModelCloned.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when the iModel is created.

Properties

userId

String

Globally Unique Identifier of the user that created the iModel.

imodelId

String

Globally Unique Identifier of the iModel.

Example

JSON

{
   "content": {
        "userId":"e5c7ae4f-2d72-4319-b96a-d46492e4f860",
        "imodelId":"72640bf2-2173-4276-b896-c157bee0df76"
    },
    "eventType": "iModels.iModelCreated.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when the iModel is deleted.

Properties

userId

String

Globally Unique Identifier of the user that deleted the iModel.

imodelId

String

Globally Unique Identifier of the iModel.

Example

JSON

{
   "content": {
        "userId":"e5c7ae4f-2d72-4319-b96a-d46492e4f860",
        "imodelId":"72640bf2-2173-4276-b896-c157bee0df76"
    },
    "eventType": "iModels.iModelDeleted.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when new Named Version is created for the iModel.

Properties

userId

String

Globally Unique Identifier of the user that created iModel named version.

imodelId

String

Globally Unique Identifier of the iModel.

versionId

String

Globally Unique Identifier of the Named Version.

changesetId

String

Changeset id is a 40 characters SHA1 hash that is used to validate Changeset. The id of Changeset is generated from the id of its parent as well as its contents.

changesetIndex

String

Index of the Changeset (increasing, but not necessarily sequential).

Example

JSON

{
   "content": {
        "userId":"e5c7ae4f-2d72-4319-b96a-d46492e4f860",
        "imodelId":"72640bf2-2173-4276-b896-c157bee0df76",
        "versionId":"51c0ce59-a60d-47fc-a2e4-974712c707ce",
        "changesetId":"254c63645055a96d4a920425f5dfbc3adec5b602",
        "changesetIndex":"1"
    },
    "eventType": "iModels.namedVersionCreated.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

iTwins Events

Event that gets triggered when a iTwin is created.

Properties

parentId

String

Globally Unique Identifier of the parent iTwin.

iTwinClass

String

iTwin class.

iTwinSubClass

String

iTwin subclass.

accountOwnerId

String

Globally Unique Identifier of the account owner.

eventCreatedBy

String

Globally Unique Identifier of the user who created the iTwin.

accountOwnerType

String

Type of the account owner.

Example

JSON

{
   "content": {
        "parentId":"8f6bd249-d17e-49b9-9d70-613611b8b816",
        "iTwinClass":"Endeavor",
        "iTwinSubClass":"Project",
        "accountOwnerId":"e5c7ae4f-2d72-4319-b96a-d46492e4f860",
        "eventCreatedBy":"6411cfcf-d188-4788-9267-43eb0f208c8e",
        "accountOwnerType":"User"
    },
    "eventType": "iTwins.iTwinCreated.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event that gets triggered when a iTwin is deleted.

Properties

parentId

String

Globally Unique Identifier of the parent iTwin.

iTwinClass

String

iTwin class.

iTwinSubClass

String

iTwin subclass.

accountOwnerId

String

Globally Unique Identifier of the account owner.

eventCreatedBy

String

Globally Unique Identifier of the user who deleted the iTwin.

accountOwnerType

String

Type of the account owner.

Example

JSON

{
   "content": {
        "parentId":"8f6bd249-d17e-49b9-9d70-613611b8b816",
        "iTwinClass":"Endeavor",
        "iTwinSubClass":"Project",
        "accountOwnerId":"e5c7ae4f-2d72-4319-b96a-d46492e4f860",
        "eventCreatedBy":"6411cfcf-d188-4788-9267-43eb0f208c8e",
        "accountOwnerType":"User"
    },
    "eventType": "iTwins.iTwinDeleted.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Event sent when an iTwin has been updated.

Properties

parentId

String

Globally Unique Identifier of the parent iTwin.

iTwinClass

String

iTwin class.

iTwinSubClass

String

iTwin subclass.

accountOwnerId

String

Globally Unique Identifier of the account owner.

eventCreatedBy

String

Globally Unique Identifier of the user who updated the iTwin.

iTwinAccountId

String

Globally Unique Identifier of the iTwin account.

accountOwnerType

String

Type of the account owner.

Example

JSON

{
   "content": {
        "parentId":"8f6bd249-d17e-49b9-9d70-613611b8b816",
        "iTwinClass":"Endeavor",
        "iTwinSubClass":"Project",
        "accountOwnerId":"e5c7ae4f-2d72-4319-b96a-d46492e4f860",
        "eventCreatedBy":"6411cfcf-d188-4788-9267-43eb0f208c8e",
        "iTwinAccountId":"a1b2c3d4-5678-9abc-def0-123456789abc",
        "accountOwnerType":"User"
    },
    "eventType": "iTwins.iTwinUpdated.v1",
    "iTwinId":"ce40a55a-6954-4de3-85c7-f796c3e423d9",
    "messageId":"32369e4b-c9ff-47e4-b422-83b97247ce5b",
    "webhookId":"7da4ba7e-3a35-4d97-a1b0-6d453aa97493",
    "enqueuedDateTime":"11/3/2023 8:07:01 PM"
}

Request more events

We are currently working on expanding our events and would appreciate your feedback on what events we are missing.

Was this page helpful?