Activate a webhook - Webhooks

REST API Overview

Reference

Webhooks

Download API definition:

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

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

Request parameters

template

Yes

Webhook ID

Request headers

Authorization

Yes

OAuth access token with scope webhooks:modify

Yes

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

Request body

Activate Webhook

expirationDateTime

String

Webhook expiration date and time. If not provided will default to 30 days after the request time.

Example

json

{
    "expirationDateTime": "2021-06-07T08:27:42Z"
}

Response 202 Accepted

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.

json

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

Response 403 Forbidden

User is not authorized to activate 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": "InvalidActivateWebhookRequest",
        "message": "Cannot activate a webhook. Make sure the request body is valid.",
        "details": [{
                "code": "InvalidValue",
                "message": "Provided 'expirationDateTime' value is not valid. It must be a string in ISO-8601 format.",
                "target": "expirationDateTime"
            },
            {
                "code": "InvalidChange",
                "message": "Webhook subscription '5885fb70-81c1-423b-b556-771b5ab4d55b' cannot be activated because it is already active.",
                "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

retry-after

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

Definitions

Activate Webhook

Additional properties of webhook activation.

TableSchema

expirationDateTime

String

Webhook expiration date and time. If not provided will default to 30 days after the request time.

Error

Contains error information.

TableSchema

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

error

Error

Error information.