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

    Interface AddWebhookRequest

    Represents a webhook creation request.

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

    Properties

    filter? isFeedHooks isMediaHooks? isThumbnailHooks? isTranscoderHooks? isViewerConnectionHooks? 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.

    isFeedHooks: boolean

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

    isMediaHooks?: boolean

    Set to true to send webhook events on media asset processing/errored/completed/deleted. Only media assets of type recording and clip types can trigger webhooks.

    false.

    isThumbnailHooks?: boolean

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

    false.

    isTranscoderHooks?: boolean

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

    false.

    isViewerConnectionHooks?: boolean

    Set to true to send webhook events on important events related to viewers.

    false.

    url: string

    Url to send webhook data to.

    Settings

    Member Visibility

    On This Page

    Properties