@dolbyio/dolbyio-rest-apis-client - v6.0.0
    Preparing search index...

    Interface Webhook

    Represents a webhook.

    interface Webhook {
        disabled?: { reason: string; until: string };
        id: number;
        isFeedHooks: boolean;
        isMediaHooks: boolean;
        isRecordingHooks: boolean;
        isThumbnailHooks: boolean;
        isTranscoderHooks: boolean;
        isViewerConnectionHooks: boolean;
        secret: string;
        url: string;
    }
    Index

    Properties

    disabled? id isFeedHooks isMediaHooks isRecordingHooks isThumbnailHooks isTranscoderHooks isViewerConnectionHooks secret url

    Properties

    disabled?: { reason: string; until: string }

    Your webhook may be temporarily disabled if too many attempted webhook events timeout. You can re-enable it immediately by updating the url or setting UpdateWebhookRequest.reEnable to true via Update Webhook.

    Type Declaration

    • reason: string

      Reason why the webhook was disabled.

    • until: string
    id: number

    Identifier of the webhook.

    isFeedHooks: boolean

    If true sends webhook events on feeds start/stop.

    isMediaHooks: boolean

    If true sends webhook events media asset processing/errored/completed/deleted. Only media assets of type recording and clip types can trigger webhooks.

    isRecordingHooks: boolean

    If true sends webhook events on recording start/error/complete/deleted.

    isThumbnailHooks: boolean

    If true sends webhook events on thumbnail generation.

    isTranscoderHooks: boolean

    If true sends webhook events on transcoder instance updates.

    isViewerConnectionHooks: boolean

    If true sends webhook events on important events related to viewers.

    secret: string

    Base64 string of signing secret.

    url: string

    Url to send webhook data to.

    Settings

    Member Visibility

    On This Page

    Properties