Request

Response

    Interface: HookPayload

    Defined in: model/hookPayload.ts:10

    Specifies the details of a webhook to be created.

    Export

    HookPayload

    Properties

    autoReactivateHook?

    optional autoReactivateHook: boolean

    Defined in: model/hookPayload.ts:22

    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.

    Memberof

    HookPayload


    callbackUrl

    callbackUrl: string

    Defined in: model/hookPayload.ts:16

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

    Memberof

    HookPayload


    callbackWithEventPayloadOnly?

    optional callbackWithEventPayloadOnly: boolean

    Defined in: model/hookPayload.ts:70

    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.

    Memberof

    HookPayload


    filter?

    optional filter: string

    Defined in: model/hookPayload.ts:46

    A Jsonpath expression that you can use to filter the callbacks you receive. See Callback Filtering for more information.

    Memberof

    HookPayload


    hookAttribute?

    optional hookAttribute: object

    Defined in: model/hookPayload.ts:34

    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.

    Memberof

    HookPayload


    hookExpiry?

    optional hookExpiry: string

    Defined in: model/hookPayload.ts:40

    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.

    Memberof

    HookPayload


    hubId?

    optional hubId: string

    Defined in: model/hookPayload.ts:52

    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 a Data Management Hub ID corresponds to an Account ID. For Forma, a Data Management Hub ID corresponds to a Forma Hub ID. To convert either to a Data Management Hub ID, prefix the ID with b.. For example, a BIM 360 Account ID or Forma Hub ID of c8b0c73d-3ae9 translates to a Data Management Hub ID of b.c8b0c73d-3ae9.

    Memberof

    HookPayload


    projectId?

    optional projectId: string

    Defined in: model/hookPayload.ts:58

    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 Forma project IDs are different from Data Management Project IDs. To convert BIM 360 or Forma Project IDs to Data Management Project IDs, prefix them with b.. For example, a Project ID of c8b0c73d-3ae9 becomes b.c8b0c73d-3ae9.

    Memberof

    HookPayload


    scope

    scope: object

    Defined in: model/hookPayload.ts:28

    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.

    Memberof

    HookPayload


    tenant?

    optional tenant: string

    Defined in: model/hookPayload.ts:64

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

    Memberof

    HookPayload