Available Events - Changed Elements

Changed Elements

Download API definition:

The following events are available for the Changed Elements API. To set up automation based on these events, create a webhook using the Webhooks API.

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.

eventType

String

Webhook event type.

enqueuedDateTime

String

Date and time when event was enqueued.

iTwinId

String

iTwin Id.

messageId

String

Event message Id.

webhookId

String

Webhook Id.

Example

JSON

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

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",
    "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"
}

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",
    "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"
}

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?

Example Event

changedElements.jobCompleted.v1

changedElements.jobCompleted.v2