Sync event sources

POST /api/v2/buyer/advertisers/{advertiserId}/event-sources/sync Syncs your event source configurations onto an advertiser. Each source gets an event_source_id you pass on every log-event call. Sync is idempotent — re-sending the same config returns unchanged. Events sent to an unregistered source are rejected, so sync before you log.

Request

curl -X POST https://api.interchange.io/api/v2/buyer/advertisers/12345/event-sources/sync \
  -H "Authorization: Bearer $SCOPE3_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "account": { "account_id": "12345" },
    "event_sources": [
      {
        "event_source_id": "hightouch_purchase",
        "name": "Hightouch Purchase Sync",
        "event_types": ["purchase", "refund"],
        "integration_platform": "Hightouch",
        "mapping": {
          "eventIdField": "id",
          "eventTypeField": "event_type",
          "eventTimeField": "occurred_at",
          "userMatchFields": ["email_sha256", "sc3clid"],
          "valueField": "revenue",
          "currencyField": "currency",
          "orderIdField": "order_id",
          "consentField": "consent_status",
          "dedupeStrategy": "Use the warehouse event primary key."
        },
        "test_event_code": "TEST-HIGHTOUCH"
      }
    ]
  }'

Parameters

Field	Type	Required	Notes
`advertiserId`	string	Yes	Path. Owning advertiser
`account`	object	Yes	`{ account_id }`. `account_id` must equal the path `advertiserId`
`event_sources`	object[]	Yes	1–50 sources to sync
`event_sources[].event_source_id`	string	Yes	Buyer-assigned ID (1–255 chars)
`event_sources[].name`	string	No	Human-readable label (1–255 chars)
`event_sources[].event_types`	enum[]	No	Restricts accepted types (e.g. `purchase`, `lead`, `add_to_cart`, `custom`). Omit to accept all
`event_sources[].allowed_domains`	string[]	No	Domains authorized to send events for this source
`event_sources[].integration_platform`	string	No	Scope3 extension for the source system, such as `Hightouch`, `CRM`, `MMP`, or `server API`
`event_sources[].mapping`	object	No	Scope3 extension that records the source fields used to produce `log-event` payloads
`event_sources[].mapping.eventIdField`	string	No	Source field mapped to `events[].event_id` for dedupe and retries
`event_sources[].mapping.eventTypeField`	string	No	Source field or expression mapped to canonical ADCP `event_type`
`event_sources[].mapping.eventTimeField`	string	No	Source timestamp field mapped to `event_time`
`event_sources[].mapping.userMatchFields`	string[]	No	Source fields available for matching, such as click IDs or hashed identifiers
`event_sources[].mapping.valueField`	string	No	Source field mapped to `events[].custom_data.value`
`event_sources[].mapping.currencyField`	string	No	Source field mapped to `events[].custom_data.currency`
`event_sources[].mapping.orderIdField`	string	No	Source field mapped to `events[].custom_data.order_id`
`event_sources[].mapping.contentIdsField`	string	No	Source field mapped to product, SKU, or content identifiers
`event_sources[].mapping.consentField`	string	No	Source field used to gate consented event forwarding
`event_sources[].mapping.dedupeStrategy`	string	No	How stable event IDs are generated and deduplicated
`event_sources[].mapping.notes`	string	No	Human-readable implementation notes for the source contract
`event_sources[].test_event_code`	string	No	Default test code to use while validating the integration
`delete_missing`	boolean	No	Archive buyer-managed sources not in this payload (default `false`)

Response

{
  "event_sources": [
    { "event_source_id": "hightouch_purchase", "action": "created" }
  ]
}

action is one of created, updated, unchanged, failed, or deleted. A failed result carries an error message; the rest of the batch still applies.

Errors

400 VALIDATION_ERROR — account.account_id does not match the path, empty event_sources, or more than 50 sources.
404 NOT_FOUND — advertiserId does not exist or is not visible to the authenticated account.

See Errors for the full error contract.

Event source tasks

All event source operations

Log Events guide

How event sources and log-event fit together

Log event

Send events through a registered source

Conversion API

Identity-hashing rules and event payloads

Getting Started

Advertisers

Campaigns

Product Discovery

Webhooks

Creatives

Signals & Brand

Audiences & Inventory

Measurement & Conversions

Reporting & Activity

Planning & Governance

Connections

Account & Billing

Request

Parameters

Response

Errors

Event source tasks

Log Events guide

Log event

Conversion API

​Request

​Parameters

​Response

​Errors

​Related

Event source tasks

Log Events guide

Log event

Conversion API

Request

Parameters

Response

Errors

Related