Request

Response

    Interface: ModifyHookPayload

    Defined in: model/modifyHookPayload.ts:9

    Specifies the details of a webhook to be updated.

    Export

    ModifyHookPayload

    Properties

    autoReactivateHook?

    optional autoReactivateHook: boolean

    Defined in: model/modifyHookPayload.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.

    Memberof

    ModifyHookPayload


    filter?

    optional filter: string

    Defined in: model/modifyHookPayload.ts:33

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

    See Callback Filtering for more information.

    Memberof

    ModifyHookPayload


    hookAttribute?

    optional hookAttribute: object

    Defined in: model/modifyHookPayload.ts:39

    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

    ModifyHookPayload


    hookExpiry?

    optional hookExpiry: string

    Defined in: model/modifyHookPayload.ts:53

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

    Memberof

    ModifyHookPayload


    status?

    optional status: StatusRequest

    Defined in: model/modifyHookPayload.ts:15

    Memberof

    ModifyHookPayload


    token?

    optional token: string

    Defined in: model/modifyHookPayload.ts:47

    A secret token that is used to generate a hash signature, which is passed along with notification requests to the callback URL.

    See the Secret Token section in API Basics for more information.

    Memberof

    ModifyHookPayload