Interface: HookPayload

autoReactivateHook?

optional autoReactivateHook: boolean

Defined in: model/hookPayload.ts:25

true - Automatically reactivate the webhook if it becomes inactive.

false - (Default) Do not reactivate the webhook if it becomes inactive.

See Event Delivery Guarantees for more information on how the webhooks service handles reactivation.

callbackUrl

callbackUrl: string

Defined in: model/hookPayload.ts:15

The URL to send notifications to when the event is triggered.

callbackWithEventPayloadOnly?

optional callbackWithEventPayloadOnly: boolean

Defined in: model/hookPayload.ts:81

true - The callback request payload must only contain information about the event. It must not contain any information about the webhook.

false - (Default) The callback request payload must contain information about the event as well as the webhook.

filter?

optional filter: string

Defined in: model/hookPayload.ts:51

A Jsonpath expression that you can use to filter the callbacks you receive.

See Callback Filtering for more information.

hookAttribute?

optional hookAttribute: object

Defined in: model/hookPayload.ts:37

Specifies the extent to which the event is monitored. For example, if the scope is folder, the webhooks service generates a notification for the specified event occurring in any sub folder or item within that folder.

hookExpiry?

optional hookExpiry: string

Defined in: model/hookPayload.ts:43

The date and time the webhook will expire, formatted as an ISO 8601 date/time string. If you do not specify this attribute or set it to null, the webhook will never expire.

hubId?

optional hubId: string

Defined in: model/hookPayload.ts:59

The ID of the hub that contains the entity that you want to monitor. Specify this attribute if the user calling this operation is a member of a large number of projects.

For BIM 360 Docs and ACC Docs, a hub ID corresponds to an Account ID. To convert a BIM 360 or ACC Account ID to a hub ID, prefix the Account ID with b.. For example, an Account ID of c8b0c73d-3ae9 translates to a hub ID of b.c8b0c73d-3ae9.

projectId?

optional projectId: string

Defined in: model/hookPayload.ts:67

The ID of the project that contains the entity that you want to monitor Specify this attribute if the user calling this operation is a member of a large number of projects.

BIM 360 and ACC project IDs are different to Data Management project IDs. To convert a BIM 360 and ACC project IDs to Data Management project IDs, prefix the BIM 360 or ACC Project ID with b.. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.

scope

scope: object

Defined in: model/hookPayload.ts:31

Specifies the extent to which the event is monitored. For example, if the scope is folder, the webhooks service generates a notification for the specified event occurring in any sub folder or item within that folder.

tenant?

optional tenant: string

Defined in: model/hookPayload.ts:73

The tenant associated with the event. If specified on the webhook, the event’s tenant must match the webhook’s tenant.