@adcp/client API Reference - v4.19.0
    Preparing search index...

    Interface WebhookAsset

    Webhook for server-side dynamic content rendering (DCO)

    interface WebhookAsset {
        url: string;
        method?: HTTPMethod;
        timeout_ms?: number;
        supported_macros?: string[];
        required_macros?: string[];
        response_type: WebhookResponseType;
        security: {
            method: WebhookSecurityMethod;
            hmac_header?: string;
            api_key_header?: string;
        };
        provenance?: Provenance;
    }
    Index

    Properties

    url method? timeout_ms? supported_macros? required_macros? response_type security provenance?

    Properties

    url: string

    Webhook URL to call for dynamic content

    method?: HTTPMethod
    timeout_ms?: number

    Maximum time to wait for response in milliseconds

    supported_macros?: string[]

    Universal macros that can be passed to webhook (e.g., DEVICE_TYPE, COUNTRY). See docs/creative/universal-macros.mdx for full list.

    required_macros?: string[]

    Universal macros that must be provided for webhook to function

    response_type: WebhookResponseType
    security: {
        method: WebhookSecurityMethod;
        hmac_header?: string;
        api_key_header?: string;
    }

    Security configuration for webhook calls

    Type Declaration

    • method: WebhookSecurityMethod
    • Optionalhmac_header?: string

      Header name for HMAC signature (e.g., 'X-Signature')

    • Optionalapi_key_header?: string

      Header name for API key (e.g., 'X-API-Key')

    provenance?: Provenance

    Settings

    Member Visibility

    On This Page

    Properties