Skip to main content
POST
/
advertisers
/
{advertiserId}
/
event-sources
Create event source
curl --request POST \
  --url https://api.agentic.scope3.com/api/v2/buyer/advertisers/{advertiserId}/event-sources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "eventSourceId": "retailer_sales",
  "name": "Retailer Sales Pixel"
}
'
{
  "eventSource": {
    "eventSourceId": "retailer_sales",
    "name": "Retailer Sales Pixel",
    "eventTypes": [
      "page_view"
    ],
    "allowedDomains": [
      "<string>"
    ],
    "createdAt": "2026-01-15T10:30:00.000Z",
    "updatedAt": "2026-01-20T14:45:00.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

API key or access token

Path Parameters

​
advertiserId
string
required

Unique identifier for the advertiser

Minimum string length: 1
Example:

"12345"

Body

application/json

Request body for creating an event source

​
eventSourceId
string
required

Identifier for this event source, referenced by optimization goals

Required string length: 1 - 255
Example:

"retailer_sales"

​
name
string
required

Human-readable name for this event source

Required string length: 1 - 255
Example:

"Retailer Sales Pixel"

​
eventTypes
enum<string>[]

Event types this source handles. When omitted, accepts all event types.

Minimum array length: 1

IAB ECAPI event type to optimize for

Available options:
page_view,
view_content,
select_content,
select_item,
search,
share,
add_to_cart,
remove_from_cart,
viewed_cart,
add_to_wishlist,
initiate_checkout,
add_payment_info,
purchase,
refund,
lead,
qualify_lead,
close_convert_lead,
disqualify_lead,
complete_registration,
subscribe,
start_trial,
app_install,
app_launch,
contact,
schedule,
donate,
submit_application,
custom
Example:
["purchase", "add_to_cart"]
​
allowedDomains
string[]

Domains authorized to send events for this source

Minimum string length: 1
Example:
["shop.example.com", "checkout.example.com"]

Response

Create event source

Response containing a single event source

​
eventSource
object
required

Event source resource representation