Table of contents
Webhooks
Download API definition:

Changelog

Apr 25, 2024

Announcement

Webhooks API version 2 is available in General Availability.

Feb 20, 2024

Added

Added technology preview operation 'Create webhook'.

Added technology preview operation 'Delete webhook'.

Added technology preview operation 'Get webhook'.

Added technology preview operation 'Get webhooks'.

Added technology preview operation 'Update webhook'.

Added event 'iModels.iModelDeleted.v1'

Added event 'iModels.iModelCreated.v1'

Added event 'iModels.namedVersionCreated.v1'

Added event 'iModels.changesReady.v1'

Added event 'accessControl.memberAdded.v1'

Added event 'accessControl.memberRemoved.v1'

Added event 'accessControl.roleAssigned.v1'

Added event 'accessControl.roleUnassigned.v1'

Added event 'iTwins.iTwinCreated.v1'

Added event 'iTwins.iTwinDeleted.v1'

Added event 'synchronization.jobCompleted.v1'

Added event 'transformations.jobCompleted.v1'

Removed

Removed operation 'Activate a webhook'.

Removed operation 'Confirm webhook callback ownership'.

Removed operation 'Create iModel events webhook'.

Removed operation 'Deactivate a webhook'.

Removed operation 'Delete a webhook'.

Removed operation 'Get a list of user webhooks'.

Removed operation 'Get the details for a webhook'.

Removed event 'iModelDeletedEvent'

Removed event 'NamedVersionCreatedEvent'

Removed event 'ChangesetPushedEvent'

Removed event 'ChangesetGroupCompletedEvent'

Removed event 'ChangesReadyEvent'

Announcement

Webhooks API version 2 is available in Technical Preview. This update adds support for webhooks on the Account scope. We have also added support for events triggered by the Access Control, iTwins, iModel, Synchronization, and Transformations APIs.

Added

Added event 'realityModeling.jobCompleted.v1'

Added event 'realityAnalysis.jobCompleted.v1'

Added event 'realityConversion.jobCompleted.v11'

Added event 'changedElements.jobCompleted.v1'

Oct 12, 2023

Announcement

Webhooks API version 2 is available in Technical Preview. This update adds support for webhooks on the Account scope. We have also added support for events triggered by the Access Control, iTwins, iModel, Synchronization, and Transformaion APIs.

Oct 12, 2023

Added

Added technology preview operation 'Create webhook'.

Added technology preview operation 'Delete webhook'.

Added technology preview operation 'Get webhook'.

Added technology preview operation 'Get webhooks'.

Added technology preview operation 'Update webhook'.

Added event 'iModels.iModelDeleted.v1'

Added event 'iModels.iModelCreated.v1'

Added event 'iModels.namedVersionCreated.v1'

Added event 'iModels.changesReady.v1'

Added event 'accessControl.memberAdded.v1'

Added event 'accessControl.memberRemoved.v1'

Added event 'accessControl.roleAssigned.v1'

Added event 'accessControl.roleUnassigned.v1'

Added event 'iTwins.iTwinCreated.v1'

Added event 'iTwins.iTwinDeleted.v1'

Added event 'synchronization.jobCompleted.v1'

Added event 'transformations.jobCompleted.v1'

Oct 12, 2023

Announcement

Webhooks API version 2 is available in Technical Preview. This update adds support for webhooks on the Account scope. We have also added support for events triggered by the Access Control, iTwins, iModel, Synchronization, and Transformaion APIs.

Oct 4, 2023

Announcement

Initial technology preview release of the API.

Added

Callback URL validation

Added callback URL validation for all new webhooks. Webhook will not be activated until the ownership of the callback is validated.

Added new API operation for manual callback URL validation.

Schema changes

  • Added new webhook property isValidated in webhook collection response.
  • Added new properties isValidated and validationState in webhook details response.
  • Added id property in webhook creation response.
Changed

Event names

Event ChangeSetPushedEvent was renamed to ChangesetPushedEvent.

Added

New ChangesetGroupCompletedEvent

Added the option to subscribe to ChangesetGroupCompletedEvent events for iModels. ChangesetGroupCompletedEvent is triggered when a changeset group is closed with state "Completed".

Added

New ChangesReadyEvent

Added the option to subscribe to ChangesReadyEvent events for iModels. ChangesReadyEvent is triggered when there are new changes to the iModel which are ready to be processed.

Removed

NamedVersionCreatedEvent Property

Removed the versionName property from the NamedVersionCreatedEvent event.

Added

Added technology preview operation 'Create account webhook'.

Added technology preview operation 'Delete account webhook'.

Added technology preview operation 'Get account webhook'.

Added technology preview operation 'Get account webhooks'.

Added technology preview operation 'Update account webhook'.

Added

Added technology preview operation 'Create webhook'.

Added technology preview operation 'Get webhook'.

Added technology preview operation 'Get webhooks'.

Added technology preview operation 'Update webhook'.

Added technology preview operation 'Delete webook'.

Added technology preview operation 'Delete webhook'.

Added technology preview operation 'Create webhook'.

Added technology preview operation 'Delete webhook'.

Added technology preview operation 'Get webhook'.

Added technology preview operation 'Get webhooks'.

Added technology preview operation 'Update webhook'.

Oct 3, 2023

Announcement

Initial technology preview release of the API.

Added

Callback URL validation

Added callback URL validation for all new webhooks. Webhook will not be activated until the ownership of the callback is validated.

Added new API operation for manual callback URL validation.

Schema changes

  • Added new webhook property isValidated in webhook collection response.
  • Added new properties isValidated and validationState in webhook details response.
  • Added id property in webhook creation response.
Changed

Event names

Event ChangeSetPushedEvent was renamed to ChangesetPushedEvent.

Added

New ChangesetGroupCompletedEvent

Added the option to subscribe to ChangesetGroupCompletedEvent events for iModels. ChangesetGroupCompletedEvent is triggered when a changeset group is closed with state "Completed".

Added

New ChangesReadyEvent

Added the option to subscribe to ChangesReadyEvent events for iModels. ChangesReadyEvent is triggered when there are new changes to the iModel which are ready to be processed.

Removed

NamedVersionCreatedEvent Property

Removed the versionName property from the NamedVersionCreatedEvent event.

Added

Added technology preview operation 'Create account webhook'.

Added technology preview operation 'Delete account webhook'.

Added technology preview operation 'Get account webhook'.

Added technology preview operation 'Get account webhooks'.

Added technology preview operation 'Update account webhook'.

Added technology preview operation 'Create account webhook'.

Added technology preview operation 'Delete account webhook'.

Added technology preview operation 'Get account webhook'.

Added technology preview operation 'Get account webhooks'.

Added technology preview operation 'Update account webhook'.

Added

Added technology preview operation 'Create account webhook'.

Added technology preview operation 'Delete account webhook'.

Added technology preview operation 'Get account webhook'.

Added technology preview operation 'Get account webhooks'.

Added technology preview operation 'Update account webhook'.

Jun 9, 2023

Announcement

Initial technology preview release of the API.

Added

Callback URL validation

Added callback URL validation for all new webhooks. Webhook will not be activated until the ownership of the callback is validated.

Added new API operation for manual callback URL validation.

Schema changes

  • Added new webhook property isValidated in webhook collection response.
  • Added new properties isValidated and validationState in webhook details response.
  • Added id property in webhook creation response.
Changed

Event names

Event ChangeSetPushedEvent was renamed to ChangesetPushedEvent.

Added

New ChangesetGroupCompletedEvent

Added the option to subscribe to ChangesetGroupCompletedEvent events for iModels. ChangesetGroupCompletedEvent is triggered when a changeset group is closed with state "Completed".

Added

New ChangesReadyEvent

Added the option to subscribe to ChangesReadyEvent events for iModels. ChangesReadyEvent is triggered when there are new changes to the iModel which are ready to be processed.

Removed

NamedVersionCreatedEvent Property

Removed the versionName property from the NamedVersionCreatedEvent event.