@adcp/sdk API Reference - v7.9.0
    Preparing search index...

    Variable WebhookAssetSchemaConst

    WebhookAssetSchema: ZodObject<
        {
            asset_type: ZodLiteral<"webhook">;
            url: ZodString;
            method: ZodOptional<
                ZodUnion<readonly [ZodLiteral<"GET">, ZodLiteral<"POST">]>,
            >;
            timeout_ms: ZodOptional<ZodNumber>;
            supported_macros: ZodOptional<
                ZodArray<
                    ZodUnion<
                        readonly [
                            ZodUnion<
                                readonly [
                                    ZodLiteral<"MEDIA_BUY_ID">,
                                    ZodLiteral<"PACKAGE_ID">,
                                    ZodLiteral<"CREATIVE_ID">,
                                    ZodLiteral<"CACHEBUSTER">,
                                    ZodLiteral<"TIMESTAMP">,
                                    ZodLiteral<"CLICK_URL">,
                                    ZodLiteral<"GDPR">,
                                    ZodLiteral<"GDPR_CONSENT">,
                                    ZodLiteral<"US_PRIVACY">,
                                    ZodLiteral<"GPP_STRING">,
                                    ZodLiteral<"GPP_SID">,
                                    ZodLiteral<"IP_ADDRESS">,
                                    ZodLiteral<"LIMIT_AD_TRACKING">,
                                    ZodLiteral<"DEVICE_TYPE">,
                                    ZodLiteral<"OS">,
                                    ZodLiteral<"OS_VERSION">,
                                    ZodLiteral<"DEVICE_MAKE">,
                                    ZodLiteral<"DEVICE_MODEL">,
                                    ZodLiteral<"USER_AGENT">,
                                    ZodLiteral<"APP_BUNDLE">,
                                    ZodLiteral<"APP_NAME">,
                                    ZodLiteral<"COUNTRY">,
                                    ZodLiteral<"REGION">,
                                    ZodLiteral<"CITY">,
                                    ZodLiteral<"ZIP">,
                                    ZodLiteral<"DMA">,
                                    ZodLiteral<"LAT">,
                                    ZodLiteral<"LONG">,
                                    ZodLiteral<"DEVICE_ID">,
                                    ZodLiteral<"DEVICE_ID_TYPE">,
                                    ZodLiteral<"DOMAIN">,
                                    ZodLiteral<"PAGE_URL">,
                                    ZodLiteral<"REFERRER">,
                                    ZodLiteral<"KEYWORDS">,
                                    ZodLiteral<"PLACEMENT_ID">,
                                    ZodLiteral<"FOLD_POSITION">,
                                    ZodLiteral<"AD_WIDTH">,
                                    ZodLiteral<"AD_HEIGHT">,
                                    ZodLiteral<"VIDEO_ID">,
                                    ZodLiteral<"VIDEO_TITLE">,
                                    ZodLiteral<"VIDEO_DURATION">,
                                    ZodLiteral<"VIDEO_CATEGORY">,
                                    ZodLiteral<"CONTENT_GENRE">,
                                    ZodLiteral<"CONTENT_RATING">,
                                    ZodLiteral<"PLAYER_WIDTH">,
                                    ZodLiteral<"PLAYER_HEIGHT">,
                                    ZodLiteral<"POD_POSITION">,
                                    ZodLiteral<"POD_SIZE">,
                                    ZodLiteral<"AD_BREAK_ID">,
                                    ZodLiteral<"STATION_ID">,
                                    ZodLiteral<"COLLECTION_NAME">,
                                    ZodLiteral<"INSTALLMENT_ID">,
                                    ZodLiteral<"AUDIO_DURATION">,
                                    ZodLiteral<"TMPX">,
                                    ZodLiteral<"AXEM">,
                                    ZodLiteral<"CATALOG_ID">,
                                    ZodLiteral<"SKU">,
                                    ZodLiteral<"GTIN">,
                                    ZodLiteral<"OFFERING_ID">,
                                    ZodLiteral<"JOB_ID">,
                                    ZodLiteral<"HOTEL_ID">,
                                    ZodLiteral<"FLIGHT_ID">,
                                    ZodLiteral<"VEHICLE_ID">,
                                    ZodLiteral<"LISTING_ID">,
                                    ZodLiteral<"STORE_ID">,
                                    ZodLiteral<"PROGRAM_ID">,
                                    ZodLiteral<"DESTINATION_ID">,
                                    ZodLiteral<"CREATIVE_VARIANT_ID">,
                                    ZodLiteral<"APP_ITEM_ID">,
                                ],
                            >,
                            ZodString,
                        ],
                    >,
                >,
            >;
            required_macros: ZodOptional<
                ZodArray<
                    ZodUnion<
                        readonly [
                            ZodUnion<
                                readonly [
                                    ZodLiteral<"MEDIA_BUY_ID">,
                                    ZodLiteral<"PACKAGE_ID">,
                                    ZodLiteral<"CREATIVE_ID">,
                                    ZodLiteral<"CACHEBUSTER">,
                                    ZodLiteral<"TIMESTAMP">,
                                    ZodLiteral<"CLICK_URL">,
                                    ZodLiteral<"GDPR">,
                                    ZodLiteral<"GDPR_CONSENT">,
                                    ZodLiteral<"US_PRIVACY">,
                                    ZodLiteral<"GPP_STRING">,
                                    ZodLiteral<"GPP_SID">,
                                    ZodLiteral<"IP_ADDRESS">,
                                    ZodLiteral<"LIMIT_AD_TRACKING">,
                                    ZodLiteral<"DEVICE_TYPE">,
                                    ZodLiteral<"OS">,
                                    ZodLiteral<"OS_VERSION">,
                                    ZodLiteral<"DEVICE_MAKE">,
                                    ZodLiteral<"DEVICE_MODEL">,
                                    ZodLiteral<"USER_AGENT">,
                                    ZodLiteral<"APP_BUNDLE">,
                                    ZodLiteral<"APP_NAME">,
                                    ZodLiteral<"COUNTRY">,
                                    ZodLiteral<"REGION">,
                                    ZodLiteral<"CITY">,
                                    ZodLiteral<"ZIP">,
                                    ZodLiteral<"DMA">,
                                    ZodLiteral<"LAT">,
                                    ZodLiteral<"LONG">,
                                    ZodLiteral<"DEVICE_ID">,
                                    ZodLiteral<"DEVICE_ID_TYPE">,
                                    ZodLiteral<"DOMAIN">,
                                    ZodLiteral<"PAGE_URL">,
                                    ZodLiteral<"REFERRER">,
                                    ZodLiteral<"KEYWORDS">,
                                    ZodLiteral<"PLACEMENT_ID">,
                                    ZodLiteral<"FOLD_POSITION">,
                                    ZodLiteral<"AD_WIDTH">,
                                    ZodLiteral<"AD_HEIGHT">,
                                    ZodLiteral<"VIDEO_ID">,
                                    ZodLiteral<"VIDEO_TITLE">,
                                    ZodLiteral<"VIDEO_DURATION">,
                                    ZodLiteral<"VIDEO_CATEGORY">,
                                    ZodLiteral<"CONTENT_GENRE">,
                                    ZodLiteral<"CONTENT_RATING">,
                                    ZodLiteral<"PLAYER_WIDTH">,
                                    ZodLiteral<"PLAYER_HEIGHT">,
                                    ZodLiteral<"POD_POSITION">,
                                    ZodLiteral<"POD_SIZE">,
                                    ZodLiteral<"AD_BREAK_ID">,
                                    ZodLiteral<"STATION_ID">,
                                    ZodLiteral<"COLLECTION_NAME">,
                                    ZodLiteral<"INSTALLMENT_ID">,
                                    ZodLiteral<"AUDIO_DURATION">,
                                    ZodLiteral<"TMPX">,
                                    ZodLiteral<"AXEM">,
                                    ZodLiteral<"CATALOG_ID">,
                                    ZodLiteral<"SKU">,
                                    ZodLiteral<"GTIN">,
                                    ZodLiteral<"OFFERING_ID">,
                                    ZodLiteral<"JOB_ID">,
                                    ZodLiteral<"HOTEL_ID">,
                                    ZodLiteral<"FLIGHT_ID">,
                                    ZodLiteral<"VEHICLE_ID">,
                                    ZodLiteral<"LISTING_ID">,
                                    ZodLiteral<"STORE_ID">,
                                    ZodLiteral<"PROGRAM_ID">,
                                    ZodLiteral<"DESTINATION_ID">,
                                    ZodLiteral<"CREATIVE_VARIANT_ID">,
                                    ZodLiteral<"APP_ITEM_ID">,
                                ],
                            >,
                            ZodString,
                        ],
                    >,
                >,
            >;
            response_type: ZodUnion<
                readonly [
                    ZodLiteral<"html">,
                    ZodLiteral<"json">,
                    ZodLiteral<"xml">,
                    ZodLiteral<"javascript">,
                ],
            >;
            security: ZodObject<
                {
                    method: ZodUnion<
                        readonly [
                            ZodLiteral<"hmac_sha256">,
                            ZodLiteral<"api_key">,
                            ZodLiteral<"none">,
                        ],
                    >;
                    hmac_header: ZodOptional<ZodString>;
                    api_key_header: ZodOptional<ZodString>;
                },
                $loose,
            >;
            provenance: ZodOptional<
                ZodObject<
                    {
                        digital_source_type: ZodOptional<
                            ZodUnion<
                                readonly [
                                    ZodLiteral<"digital_capture">,
                                    ZodLiteral<"digital_creation">,
                                    ZodLiteral<"trained_algorithmic_media">,
                                    ZodLiteral<"composite_with_trained_algorithmic_media">,
                                    ZodLiteral<"algorithmic_media">,
                                    ZodLiteral<"composite_capture">,
                                    ZodLiteral<"composite_synthetic">,
                                    ZodLiteral<"human_edits">,
                                    ZodLiteral<"data_driven_media">,
                                ],
                            >,
                        >;
                        ai_tool: ZodOptional<
                            ZodObject<
                                {
                                    name: ZodString;
                                    version: ZodOptional<ZodString>;
                                    provider: ZodOptional<ZodString>;
                                },
                                $loose,
                            >,
                        >;
                        human_oversight: ZodOptional<
                            ZodUnion<
                                readonly [
                                    ZodLiteral<"none">,
                                    ZodLiteral<"prompt_only">,
                                    ZodLiteral<"selected">,
                                    ZodLiteral<"edited">,
                                    ZodLiteral<"directed">,
                                ],
                            >,
                        >;
                        declared_by: ZodOptional<
                            ZodObject<
                                {
                                    agent_url: ZodOptional<ZodString>;
                                    role: ZodUnion<
                                        readonly [
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                            ZodLiteral<(...)>,
                                        ],
                                    >;
                                },
                                $loose,
                            >,
                        >;
                        declared_at: ZodOptional<ZodISODateTime>;
                        created_time: ZodOptional<ZodISODateTime>;
                        c2pa: ZodOptional<ZodObject<{ manifest_url: ZodString }, $loose>>;
                        disclosure: ZodOptional<
                            ZodObject<
                                {
                                    required: ZodBoolean;
                                    jurisdictions: ZodOptional<ZodArray<ZodObject<(...), (...)>>>;
                                },
                                $loose,
                            >,
                        >;
                        verification: ZodOptional<
                            ZodArray<
                                ZodObject<
                                    {
                                        verified_by: ZodString;
                                        verified_time: ZodOptional<ZodISODateTime>;
                                        result: ZodUnion<readonly [(...), (...), (...), (...)]>;
                                        confidence: ZodOptional<ZodNumber>;
                                        details_url: ZodOptional<ZodString>;
                                    },
                                    $loose,
                                >,
                            >,
                        >;
                        ext: ZodOptional<ZodObject<{}, $loose>>;
                    },
                    $loose,
                >,
            >;
        },
        $loose,
    > = ...