Table of contents
Webhooks

Events

Download API definition:

POST https://api.bentley.com/webhooks/{id}/deactivate

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 page.

Request parameters

Name
In
Required?
Description
id
template
Yes

Webhook ID

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with scope webhooks:modify

Accept
Yes

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

Response 202 Accepted

The request has been accepted for processing.

Response 401 Unauthorized

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.

json
{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 403 Forbidden

User is not authorized to deactivate a webhook.

json
{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

Response 404 Not Found

Specified webhook was not found.

json
{
    "error": {
        "code": "WebhookNotFound",
        "message": "Requested webhook is not available."
    }
}

Response 422 Unprocessable Entity

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).

json
{
    "error": {
        "code": "InvalidDeactivateWebhookRequest",
        "message": "Cannot deactivate webhook.",
        "details": [{
            "code": "InvalidChange",
            "message": "Webhook subscription '5885fb70-81c1-423b-b556-771b5ab4d55b' cannot be deactivated because it is already deactive.",
            "target": "IsActive"
        }]
    }
}

Response 429 Too many requests

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

json
{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

Name
Description
retry-after

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

Error

Contains error information.

TableSchema
Name
Type
Description
code
String

One of a server-defined set of error codes.

message
String

A human-readable representation of the error.

target
String

The target of the error.

Error Response

Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.

TableSchema
Name
Type
Description
error

Error information.