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

    Interface SyncEventSourcesRequest

    Request parameters for configuring event sources on an account with upsert semantics. Existing event sources matched by event_source_id are updated, new ones are created. When delete_missing is true, buyer-managed event sources on the account not in this request are removed. When event_sources is omitted, the call is discovery-only: it returns all event sources on the account without modification. The response always includes both synced and seller-managed event sources for full visibility.

    interface SyncEventSourcesRequest {
        adcp_major_version?: number;
        idempotency_key: string;
        account: AccountReference;
        event_sources?: {
            event_source_id: string;
            name?: string;
            event_types?: EventType[];
            allowed_domains?: string[];
        }[];
        delete_missing?: boolean;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    adcp_major_version?: number

    The AdCP major version the buyer's payloads conform to. Sellers validate against their supported major_versions and return VERSION_UNSUPPORTED if unsupported. When omitted, the seller assumes its highest supported version.

    1

    99

    idempotency_key: string

    Client-generated unique key for at-most-once execution. event_source_id gives resource-level dedup per source, but the sync envelope emits audit events and can trigger downstream pixel provisioning — this key prevents those side effects from firing twice on retry. Also serves as a request ID on discovery-only calls (when event_sources is omitted). MUST be unique per (seller, request) pair. Use a fresh UUID v4 for each request.

    16

    255

    ^[A-Za-z0-9_.:-]{16,255}$

    event_sources?: {
        event_source_id: string;
        name?: string;
        event_types?: EventType[];
        allowed_domains?: string[];
    }[]

    Event sources to sync (create or update). When omitted, the call is discovery-only and returns all existing event sources on the account without modification.

    Type Declaration

    • event_source_id: string

      Unique identifier for this event source

    • Optionalname?: string

      Human-readable name for this event source

    • Optionalevent_types?: EventType[]

      Event types this source handles (e.g. purchase, lead). If omitted, accepts all event types.

    • Optionalallowed_domains?: string[]

      Domains authorized to send events for this event source

    delete_missing?: boolean

    When true, event sources not included in this sync will be removed

    context?: ContextObject
    ext?: ExtensionObject