The Webhooks API allows you to subscribe to events happening in iTwin Platform.

### Supported event sources

- iModels events


webhooks

webhooks-v2

---

This operation can be used to activate a deactivated webhook. Deactivated webhooks do not forward any events to the callback, activating enables this feature back again.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `webhooks:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


activate-webhook

OAuth access token with scope `webhooks:modify`

Authorization

Setting to `application/vnd.bentley.itwin-platform.v1+json` is recommended.

Accept

The request has been accepted for processing.

This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

application/json;InvalidAuthorizationScheme

User is not authorized to activate a webhook.

The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax).

This response indicates that the user has sent too many requests in a given amount of time.

The number of requests exceeds the rate-limit for the client subscription.

retry-after

---

### Event Types

Currently supported webhook event types:
- iModelDeletedEvent
- NamedVersionCreatedEvent
- ChangeSetPushedEvent
- ChangesetGroupCompletedEvent
- ChangesReadyEvent

### Security

On webhook creation, webhook secret is being generated. Before forwarding an event to client, secret is used together with whole event body to generate `HMAC-SHA256` signature which is included in `Signature` request header. Before doing anything with the received event client SHOULD use its own secret copy together with the event body and generate another signature on their end to validate the event source. If both signatures are the same, event SHOULD be accepted as valid one and ignored otherwise.

### Expiration

When creating a webhook expiration date time CAN be specified after which the webhook will become deactivated. If expiration time is not specified, webhook expires automatically after 30 days.

### Notes

Webhook deletion is not persisted after iModel deletion. When deleting an iModel make sure to delete related webhooks as well.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `webhooks:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


create-imodels-webhook

Location

---

This operation can be used to deactivate a webhook. Deactivated webhooks do not forward any events to the callback. Deactivated webhooks are not deleted and can be activated again.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `webhooks:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


deactivate-webhook

User is not authorized to deactivate a webhook.

---

Deleted webhooks can not be restored and have to be created again. If you want to temporary stop receiving events consider deactivating a webhook instead.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `webhooks:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


delete-webhook

User is not authorized to delete a webhook.

---

Returns a list of user's owned webhooks of any event source.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `webhooks:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-webhooks

OAuth access token with scope `webhooks:read`

---

Returns a detailed response of a webhook.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `webhooks:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-webhook

---

This operation can be used to manually confirm webhook callback ownership if a client application does not support required handshake. Fully constructed URL with required query parameters values for this operation can be found within automatic validation request header `WebHook-Request-Callback` that is sent to specified callback URL after webhook is created. If webhook callback ownership was confirmed automatically, this operation should not be used anymore.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `webhooks:modify`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


confirm-webhook-callback-ownership

Webhook callback ownership was confirmed.

Tutorials - Webhooks | iTwin Platform

Manage Access Controls for your iTwin member using iTwin roles and permissions.

access-control-v2

itwins

Interact with your projects.

View, update, create, and delete projects.


projects

users

iModelHub is the control center for iModels. It is responsible for coordinating concurrent access to iModels as well as changes made to them in a form of [Changesets](https://www.itwinjs.org/learning/glossary/#changeset).

Overview of [iModelHub](https://www.itwinjs.org/learning/imodelhub/) and [iModels](https://www.itwinjs.org/learning/imodels/).

These APIs lets you retrieve metadata about the iModels pushed to iModelHub. To view, create or update your iModels use [iTwin.js](https://www.itwinjs.org/) client libraries.


imodels-v2

Digital Library to manage digital components

Digital component library and catalog management service.  It allows users to efficiently manage and distribute their digital component libraries, providing their designers with approved, proprietary components as well as approved manufacturer's content. 


library

Interact with your reality data.

View, update, create, and delete reality data.


reality-data


The Saved Views API provides a central place to store view information so it can be retrieved or shared across applications.


savedviews

The Sensor Data Service (SDS) provides a unified method for retrieving time series sensor data (and related metadata) within iTwin and other platforms. The SDS simplifies the process of connecting sensor data from sources including IoT Devices, IaaS IoT Hubs, Enterprise Systems, and other generic repositories. Availability of this data enables developers, vendors, and users to develop OT workflows to create new use cases for digital twins in their products.


sensor-data

Storage API allowing quick files managing

storage

itwin-unreal

Interact with your jobs and workspaces for Reality Modeling

Create, update, delete jobs and workspaces.

contextcapture

Interact with your data analysis jobs.

Create, update, delete jobs.

realitydataanalysis

Convert mentioned point cloud formats to web-friendly Orbit Point Cloud.

realityconversion

reality-management

Access iTwin data integrations with Carbon Calculation solutions for Embodied Carbon, Life Cycle Assessments, and more.

carbon-calculation

Access iModels data using OData v4 interface

imodels-odata

Reporting is a resource for aggregating iTwin data to build custom dashboards and integrate iTwin data with your business applications.

- Create digitial twin based reports which can be consumed through business intelligence applications such as Power BI.
- Leverage the OData feed Data Access to generate reports by combining data from multiple data streams in the digital twin.

insights-v2

# Changed Elements

The Changed Elements API provides consumers with the elements that have changed in an iModel between two changesets. This API has four operations:

1. Enable Change Tracking
2. Get Change Tracking
3. Get Comparison
4. Get Changesets

Before obtaining a comparison, it is necessary to enable change tracking of an iModel. This means that the API will be listening to the following events:
1. New Named Version Created
2. Changeset Group Completed

When any of those events trigger, the API will process the new changes and store a summary of all the elements that have changed.

After tracking is enabled and the iModel is processed, the comparison endpoint may be used to query for a summary of changed elements between any two given `ChangeSets`.

changed-elements

Forms Service

View, create, and edit details of forms that have been filled out in a project, as well as their comments, attached files, and change history.  Full CRUD functionality is available for form data, with form definitions being available in a read-only context.

Note that throughout this API the terms "form" (by itself) and "form data" both refer to the same thing: data collected from users (generally entered into controls of a UI, or programmatically generated). By contrast, a "form definition" is a piece of metadata connected to form data instances. It determines the "type" of form that is filled out, and in applications that support custom form layouts, it determines how the controls are placed in the user interface.

Form definitions should be added, imported, and customized by project administrators through the Bentley Form Manager web application; they cannot be modified using this API. The app can be found at https://connect-formmanager.bentley.com/ManageForms.aspx?projectId=yourProjectId where `yourProjectId` is replaced by the ID of the project being customized.

## Limits

All API calls that return a list of results will return a maximum of 50 results. Some endpoints support a `$top` parameter to specify a number of results to retrieve (up to the maximum) and a `continuationToken` parameter to continue paging through results, allowing access to results beyond the first 50. These parameters will be included in the documentation for those endpoints.

Clients with a Basic, Premium, or Enterprise subscription will be limited to 5000 requests per minute. Clients with a Trial subscription will be limited to 500 requests per minute.

forms

Issue Service

View, create, and edit details of issues that have been raised in a CONNECT project or context, as well as their comments, attached files, and change history.  Retrieval of form definitions (which define how to display an issue in an interactive UI) is also supported, though customization of them is not, and should be done by a project administrator through the CONNECT Issues web application, if needed. This form-editing app can be found at https://connect-formmanager.bentley.com/ManageForms.aspx?projectId=yourProjectId where `yourProjectId` is replaced by the ID of the project you're creating custom forms for.

## Limits

All API calls that return a list of results will return a maximum of 50 results. Some endpoints support a `$top` parameter to specify a number of results to retrieve (up to the maximum) and a `continuationToken` parameter to continue paging through results, allowing access to results beyond the first 50. These parameters will be included in the documentation for those endpoints.

Clients with a Basic, Premium, or Enterprise subscription will be limited to 5000 requests per minute. Clients with a Trial subscription will be limited to 500 requests per minute.

issues-v1

Export API is a cloud-based API meant to export the data from the iModels to other standard formats such as IFC or LandXML. It allows users export data from iModels which are hosted in Bentley's iModelHub to an IFC or LandXML file.

export

mesh-export

Recognize symbols and tags from a raster PnID.

pnid-to-itwin-v2

iModel Connections API is a cloud-based synchronization API meant to synchronize the data in Input Files and iModels. It allows users to establish links from their design files to iModels, hosted in Bentley's iModelHub. Users can synchronize updates to their design files.

synchronization

iModel transformations service

Perform transformations on iModels.


transformations

The Clash Detection API allows you to manage clash detection suppression rules, tests, runs, and results. You can run tests and monitor the progress.

clash-detection

The Property Validation API allows you to manage property value validation rules, tests, runs, and results. You can run tests and monitor the progress.

validation

visualization

This tutorial will teach you how to use Webhooks API to subscribe to iModel events and introduce basic event handling workflows.