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

    Interface UpdateWebhookRequest

    Represents a webhook update request.

    interface UpdateWebhookRequest {
        filter?: string;
        isFeedHooks?: boolean;
        isMediaHooks?: boolean;
        isThumbnailHooks?: boolean;
        isTranscoderHooks?: boolean;
        isViewerConnectionHooks?: boolean;
        reEnable?: boolean;
        refreshSecret?: boolean;
        url?: string;
    }
    Index

    Properties

    filter? isFeedHooks? isMediaHooks? isThumbnailHooks? isTranscoderHooks? isViewerConnectionHooks? reEnable? refreshSecret? url?

    Properties

    filter?: string

    A regular expression used to filter the events sent to this webhook based on StreamName or TranscoderName. For event types feeds, media, recording, thumbnail and viewerConnection the filter applies to the StreamName field. For event type transcoder the filter applies to the TranscoderName field. Set to null to clear value.

    isFeedHooks?: boolean

    Set to true to send webhook events on feeds start/stop.

    isMediaHooks?: boolean

    Set to true to send webhook events on media assets updates.

    isThumbnailHooks?: boolean

    Set to true to send webhook events on thumbnail generation.

    isTranscoderHooks?: boolean

    Set to true to send webhook events on transcoder instance updates.

    isViewerConnectionHooks?: boolean

    Set to true to send webhook events on viewer connection updates.

    reEnable?: boolean

    Set to true to immediately re-enable the webhook if it has been temporarily disabled.

    refreshSecret?: boolean

    Set to true to generate new signing secret for the webhook.

    url?: string

    Url to send webhook data to.

    Settings

    Member Visibility

    On This Page

    Properties