Advertiser Webhooks
Webhooks related to advertiser data
Advertiser webhooks are fired whenever advertisers are created or updated.
Advertiser Created
This is only fired when an advertiser is created at a top level. Creating a new advertiser user for an existing advertiser for example will not cause this webhook to fire.
The payload included in the Advertiser Created webhook is the same one you would receive by making a request to the Find Advertiser By ID endpoint using both the users and billing relationships.
Payload Example
The payload of the webhook, when using the POST option will look like so :
Payload
{
"network_advertiser_id": 166,
"network_id": 1,
"name": "New Advertiser",
"account_status": "active",
"network_employee_id": 152,
"internal_notes": "Internal Notes",
"address_id": 83933,
"is_contact_address_enabled": true,
"sales_manager_id": 132,
"is_expose_publisher_reporting_data": null,
"default_currency_id": "USD",
"platform_name": "Patform Name",
"platform_url": "www.platform-example.com",
"platform_username": "adv_name",
"reporting_timezone_id": 67,
"accounting_contact_email": "",
"verification_token": "Cpzx7BXU3X6BerBKtokdD0LmlB5m33",
"offer_id_macro": "oid",
"affiliate_id_macro": "affid",
"time_created": 1609951948,
"time_saved": 1609951948,
"relationship": {
"labels": {
"total": 2,
"entries": [
"labelx",
"labely"
]
},
"users": {
"total": 1,
"entries": [
{
"network_advertiser_user_id": 59,
"network_id": 1,
"network_advertiser_id": 166,
"first_name": "Advertiser",
"last_name": "User",
"email": "advertiser-user@example.com",
"title": "Title",
"work_phone": "1234567890",
"cell_phone": "1234567890",
"instant_messaging_id": 1,
"instant_messaging_identifier": "advertiser.user",
"language_id": 1,
"timezone_id": 80,
"currency_id": "USD",
"account_status": "active",
"time_created": 1609951948,
"time_saved": 1609951948
}
]
},
"account_manager": {
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"work_phone": "",
"cell_phone": "",
"instant_messaging_id": 0,
"instant_messaging_identifier": ""
},
"integrations": {
"optizmo": {
"iframe_url": "https://one.optizmo.net/api?action=manage_optoutlists"
},
"advertiser_demand_partner": null
},
"contact_address": {
"address_id": 83933,
"network_id": 1,
"address_1": "4115 Saint-Laurent",
"address_2": "Suite 200",
"city": "Montreal",
"region_code": "QC",
"country_id": 36,
"country_code": "CA",
"zip_postal_code": "H2W 1Y8"
},
"billing": {
"network_id": 1,
"network_advertiser_id": 166,
"billing_frequency": "monthly",
"invoice_amount_threshold": 500,
"tax_id": "Tax ID",
"is_invoice_creation_auto": true,
"auto_invoice_start_date": "2021-01-01 00:00:00",
"default_invoice_is_hidden": true,
"invoice_generation_days_delay": 7,
"default_payment_terms": 15,
"relationship": {
"monthly": {
"day_of_month": 26
}
}
},
"sale_manager": {
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"work_phone": "",
"cell_phone": "",
"instant_messaging_id": 0,
"instant_messaging_identifier": ""
}
},
"attribution_method": "last_touch",
"email_attribution_method": "last_affiliate_attribution"
}
Advertiser Updated
This is only fired when the advertiser itself is updated. For example it will be fired when :
- The account manager of the advertiser is changed to a different one
- The advertiser’s address is updated
- The advertiser’s billing settings are modified
It will not be fired when :
- A partner is added to the advertiser’s blacklist
- New link templates are added for the advertiser
- An advertiser user is created or updated
The payload included in the Advertiser Updated webhook is the same one you would receive by making a request to the Find Advertiser By ID endpoint using both the users and billing relationships.
Payload Example
The payload of the webhook, when using the POST option will look like so :
Payload
{
"network_advertiser_id": 166,
"network_id": 1,
"name": "Updated Advertiser",
"account_status": "active",
"network_employee_id": 152,
"internal_notes": "Internal Notes",
"address_id": 83933,
"is_contact_address_enabled": true,
"sales_manager_id": 132,
"is_expose_publisher_reporting_data": null,
"default_currency_id": "USD",
"platform_name": "Patform Name",
"platform_url": "www.platform-example.com",
"platform_username": "adv_name",
"reporting_timezone_id": 67,
"accounting_contact_email": "",
"verification_token": "Cpzx7BXU3X6BerBKtokdD0LmlB5m33",
"offer_id_macro": "oid",
"affiliate_id_macro": "affid",
"time_created": 1609951948,
"time_saved": 1609952074,
"relationship": {
"labels": {
"total": 2,
"entries": [
"labelx",
"labely"
]
},
"users": {
"total": 1,
"entries": [
{
"network_advertiser_user_id": 59,
"network_id": 1,
"network_advertiser_id": 166,
"first_name": "Advertiser",
"last_name": "User",
"email": "advertiser-user@example.com",
"title": "Title",
"work_phone": "1234567890",
"cell_phone": "1234567890",
"instant_messaging_id": 1,
"instant_messaging_identifier": "advertiser.user",
"language_id": 1,
"timezone_id": 80,
"currency_id": "USD",
"account_status": "active",
"time_created": 1609951948,
"time_saved": 1609951948
}
]
},
"account_manager": {
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"work_phone": "",
"cell_phone": "",
"instant_messaging_id": 0,
"instant_messaging_identifier": ""
},
"integrations": {
"optizmo": {
"iframe_url": "https://one.optizmo.net/api?action=manage_optoutlists"
},
"advertiser_demand_partner": null
},
"contact_address": {
"address_id": 83933,
"network_id": 1,
"address_1": "4115 Saint-Laurent",
"address_2": "Suite 200",
"city": "Montreal",
"region_code": "QC",
"country_id": 36,
"country_code": "CA",
"zip_postal_code": "H2W 1Y8"
},
"billing": {
"network_id": 1,
"network_advertiser_id": 166,
"billing_frequency": "monthly",
"invoice_amount_threshold": 500,
"tax_id": "Tax ID",
"is_invoice_creation_auto": true,
"auto_invoice_start_date": "2021-01-01 00:00:00",
"default_invoice_is_hidden": true,
"invoice_generation_days_delay": 7,
"default_payment_terms": 15,
"relationship": {
"monthly": {
"day_of_month": 26
}
}
},
"sale_manager": {
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"work_phone": "",
"cell_phone": "",
"instant_messaging_id": 0,
"instant_messaging_identifier": ""
}
},
"attribution_method": "last_touch",
"email_attribution_method": "last_affiliate_attribution"
}
Advertiser Signed Up
This is only fired when the advertiser signs up themself using the advertiser signup form.
This webhook will not fire when the advertiser is created manually inside the Everflow UI.
The payload included in the Advertiser Signed Up webhook is the same one you would receive by making a request to the Find Advertiser By ID endpoint using the users, billing and signup relationships.
Payload Example
The payload of the webhook, when using the POST option will look like so :
Payload
{
"network_advertiser_id": 263,
"network_id": 5,
"name": "Example Advertiser",
"account_status": "pending",
"network_employee_id": 32,
"internal_notes": "",
"address_id": 0,
"is_contact_address_enabled": false,
"sales_manager_id": 0,
"is_expose_publisher_reporting_data": null,
"default_currency_id": "USD",
"platform_name": "",
"platform_url": "",
"platform_username": "",
"reporting_timezone_id": 90,
"accounting_contact_email": "",
"verification_token": "",
"offer_id_macro": "oid",
"affiliate_id_macro": "affid",
"time_created": 1696551758,
"time_saved": 1696551758,
"relationship":
{
"labels":
{
"total": 0,
"entries": []
},
"users":
{
"total": 1,
"entries":
[
{
"network_advertiser_user_id": 113,
"network_id": 5,
"network_advertiser_id": 263,
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"title": "",
"work_phone": "",
"cell_phone": "",
"instant_messaging_id": 0,
"instant_messaging_identifier": "",
"language_id": 1,
"timezone_id": 90,
"currency_id": "USD",
"account_status": "active",
"time_created": 1696551758,
"time_saved": 1696551758
}
]
},
"account_manager":
{
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"work_phone": "",
"cell_phone": "",
"instant_messaging_id": 0,
"instant_messaging_identifier": ""
},
"integrations":
{
"optizmo":
{
"iframe_url": "https://some.url.com"
},
"advertiser_demand_partner": null
},
"billing":
{
"network_id": 5,
"network_advertiser_id": 263,
"billing_frequency": "other",
"invoice_amount_threshold": 0,
"tax_id": "",
"is_invoice_creation_auto": false,
"auto_invoice_start_date": "2019-06-01 00:00:00",
"default_invoice_is_hidden": false,
"invoice_generation_days_delay": 0,
"default_payment_terms": 0,
"relationship": {}
},
"sign_up":
{
"network_advertiser_id": 263,
"website_url": "everflow.io",
"referral_code": "",
"user_ip": "1.2.3.4",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.0.0 Safari/537.36",
"phone": "",
"tax_id": "",
"offer_landing_page": "everflow.io",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"time_created": 1696551757,
"relationship":
{
"custom_field_values":
[
{
"network_signup_custom_field_id": 1,
"network_advertiser_id": 263,
"field_value": "Skype"
},
{
"network_signup_custom_field_id": 2,
"network_advertiser_id": 263,
"field_value": "Facebook"
}
],
"custom_fields":
[
{
"network_signup_custom_field_id": 1,
"network_id": 5,
"field_type": "input",
"label": "Preferred Communication Method",
"field_order": 1,
"is_required": true,
"time_created": 1600979548,
"time_saved": 1696011622,
"relationship":
{
"input":
{
"placeholder": "",
"min_length": 0,
"max_length": 0,
"prefix": ""
}
},
"tooltip": "",
"section": ""
},
{
"network_signup_custom_field_id": 2,
"network_id": 5,
"field_type": "input",
"label": "Traffic Source ",
"field_order": 2,
"is_required": false,
"time_created": 1648736950,
"time_saved": 1696011622,
"relationship":
{
"input":
{
"placeholder": "",
"min_length": 0,
"max_length": 0,
"prefix": ""
}
},
"tooltip": "",
"section": ""
}
],
"mailing_address":
{
"address_id": 84531,
"network_id": 5,
"address_1": "123 Main Street",
"address_2": "",
"city": "Beverly Hills",
"region_code": "CA",
"country_id": 227,
"country_code": "US",
"zip_postal_code": "90210"
}
},
"language_id": ""
},
"sale_manager":
{
"first_name": "",
"last_name": "",
"email": "",
"work_phone": "",
"cell_phone": "",
"instant_messaging_id": 0,
"instant_messaging_identifier": ""
}
},
"attribution_method": "last_touch",
"email_attribution_method": "last_affiliate_attribution"
}