Everflow – Webhooks

Docs: Advertiser Webhooks

Mon, 01 Jan 0001 00:00:00 +0000

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"
}

Docs: Offer Webhooks

Mon, 01 Jan 0001 00:00:00 +0000

Offer webhooks are fired whenever offers are created or updated.

Offer Created

This is only fired when a offer is created. Creating a new offer URL or a new Smartlink for example will not cause this webhook to fire.

The payload included in the Offer Created webhook is the same one you would receive by making a request to the Find Offer By ID endpoint.

Payload Example

The payload of the webhook, when using the POST option will look like so :

Payload

{
    "network_offer_id": 1019,
    "network_id": 1,
    "network_advertiser_id": 64,
    "network_offer_group_id": 0,
    "name": "New Offer",
    "thumbnail_url": "https://assets.efusercontent.com/1/offers/1019/thumb/example-thumbnail.png",
    "network_category_id": 18,
    "internal_notes": "Internal Notes for the offer",
    "destination_url": "http://destination-url.com/?tid={transaction_id}",
    "server_side_url": "",
    "is_view_through_enabled": false,
    "view_through_destination_url": "",
    "preview_url": "http://preview-url.com",
    "offer_status": "active",
    "currency_id": "USD",
    "caps_timezone_id": 80,
    "project_id": "12345",
    "date_live_until": "2023-01-01",
    "html_description": "<div>Public HTML description visible to partners</div>",
    "is_using_explicit_terms_and_conditions": false,
    "terms_and_conditions": "",
    "is_force_terms_and_conditions": false,
    "is_caps_enabled": true,
    "daily_conversion_cap": 100,
    "weekly_conversion_cap": 0,
    "monthly_conversion_cap": 0,
    "global_conversion_cap": 0,
    "daily_payout_cap": 0,
    "weekly_payout_cap": 0,
    "monthly_payout_cap": 0,
    "global_payout_cap": 0,
    "daily_revenue_cap": 0,
    "weekly_revenue_cap": 0,
    "monthly_revenue_cap": 0,
    "global_revenue_cap": 0,
    "daily_click_cap": 0,
    "weekly_click_cap": 0,
    "monthly_click_cap": 0,
    "global_click_cap": 50000,
    "redirect_mode": "standard",
    "is_using_suppression_list": false,
    "suppression_list_id": 0,
    "is_must_approve_conversion": false,
    "is_allow_duplicate_conversion": true,
    "is_duplicate_filter_enabled": false,
    "duplicate_filter_targeting_action": "unknown",
    "network_tracking_domain_id": 1,
    "is_use_secure_link": true,
    "is_seo_friendly": false,
    "is_allow_deep_link": false,
    "is_session_tracking_enabled": false,
    "session_tracking_start_on": "null_value",
    "session_tracking_lifespan_hour": 0,
    "session_tracking_minimum_lifespan_second": 0,
    "is_view_through_session_tracking_enabled": false,
    "view_through_session_tracking_lifespan_minute": 0,
    "view_through_session_tracking_minimal_lifespan_second": 0,
    "is_block_already_converted": false,
    "already_converted_action": "unknown",
    "is_fail_traffic_enabled": true,
    "redirect_routing_method": "internal",
    "redirect_internal_routing_type": "priority",
    "visibility": "require_approval",
    "time_created": 1609459200,
    "time_saved": 1609459200,
    "conversion_method": "server_postback",
    "is_whitelist_check_enabled": false,
    "is_use_scrub_rate": false,
    "scrub_rate_status": "null_value",
    "scrub_rate_percentage": 0,
    "session_definition": "cookie",
    "session_duration": 24,
    "app_identifier": "553834731",
    "is_description_plain_text": false,
    "is_use_direct_linking": false,
    "relationship": {
        "category": {
            "network_category_id": 18,
            "network_id": 1,
            "name": "Business",
            "status": "active",
            "time_created": 1489692867,
            "time_saved": 1526478117
        },
        "labels": {
            "total": 2,
            "entries": [
                "label1",
                "label2"
            ]
        },
        "payout_revenue": {
            "total": 2,
            "entries": [
                {
                    "network_offer_payout_revenue_id": 68598,
                    "network_id": 1,
                    "network_offer_id": 1019,
                    "entry_name": "Install",
                    "payout_type": "cpa",
                    "payout_amount": 1.6,
                    "payout_percentage": 0,
                    "revenue_type": "rpa",
                    "revenue_amount": 2,
                    "revenue_percentage": 0,
                    "is_default": true,
                    "is_private": false,
                    "is_postback_disabled": false,
                    "is_enforce_caps": true,
                    "time_created": 1609459200,
                    "global_advertiser_event_id": 0,
                    "is_must_approve_conversion": false,
                    "is_allow_duplicate_conversion": true,
                    "is_email_attribution_default_event": false
                },
                {
                    "network_offer_payout_revenue_id": 68599,
                    "network_id": 1,
                    "network_offer_id": 1019,
                    "entry_name": "Purchase",
                    "payout_type": "cps",
                    "payout_amount": 0,
                    "payout_percentage": 5,
                    "revenue_type": "rps",
                    "revenue_amount": 0,
                    "revenue_percentage": 10,
                    "is_default": false,
                    "is_private": false,
                    "is_postback_disabled": false,
                    "is_enforce_caps": true,
                    "time_created": 1609459200,
                    "global_advertiser_event_id": 0,
                    "is_must_approve_conversion": false,
                    "is_allow_duplicate_conversion": true,
                    "is_email_attribution_default_event": false
                }
            ]
        },
        "thumbnail_asset": {
            "network_asset_id": 1571,
            "content_type": "image/png",
            "filename": "thumbnail.png",
            "url": "https://assets.efusercontent.com/5/offers/1019/thumb/example-thumbnail.png",
            "file_size": 129863,
            "image_width": 0,
            "image_height": 0
        },
        "encoded_value": "2RJ36XN",
        "is_locked_currency": false,
        "channels": {
            "total": 1,
            "entries": [
                {
                    "network_channel_id": 5,
                    "network_id": 1,
                    "name": "Facebook",
                    "status": "active",
                    "time_created": 1583177330,
                    "time_saved": 1583177330
                }
            ]
        },
        "is_locked_caps_timezone": false,
        "meta": {
            "network_offer_id": 1019,
            "network_id": 1,
            "app_id": "553834731",
            "meta_platform": "ios",
            "advertiser_campaign_name": "",
            "bundle_id": "",
            "category": "",
            "store_url": "",
            "score_rating": 0,
            "total_rating": 0,
            "size": 0,
            "developer": "",
            "version": "",
            "is_app_unavailable": false,
            "time_created": 1609948153,
            "time_app_data_saved": 0,
            "time_saved": 1609948153
        },
        "requirement_kpis": {
            "total": 0,
            "entries": []
        },
        "requirement_tracking_parameters": {
            "total": 0,
            "entries": []
        }
    },
    "is_email_attribution_enabled": false,
    "email_attribution_method": "unknown",
    "attribution_method": "last_touch"
}

Offer Updated

The Offer Updated webhook is only fired when the offer itself is updated. For example it will be fired when :

The offer name or description is updated
Payout Revenue settings are added or modified
Caps are set on the offer
Fail traffic settings are modified on the offer

It will not, however, be fired when objects linked to the offer are modified :

Visibility is granted to the partner on the offer
The offer group which includes the offer is modified
Custom payout revenue settings for certain partners are added to the offer
New offer URLs are added / modified to the offer

The payload included in the Offer Updated webhook is the same one you would receive by making a request to the Find Offer By ID endpoint.

Payload Example

The payload of the webhook, when using the POST option will look like so :

Payload

{
    "network_offer_id": 1019,
    "network_id": 1,
    "network_advertiser_id": 64,
    "network_offer_group_id": 0,
    "name": "Updated Offer",
    "thumbnail_url": "https://assets.efusercontent.com/5/offers/1019/thumb/thumbnail.png",
    "network_category_id": 18,
    "internal_notes": "Internal Notes for the offer",
    "destination_url": "http://destination-url.com/?tid={transaction_id}",
    "server_side_url": "",
    "is_view_through_enabled": false,
    "view_through_destination_url": "",
    "preview_url": "http://preview-url.com",
    "offer_status": "active",
    "currency_id": "USD",
    "caps_timezone_id": 80,
    "project_id": "12345",
    "date_live_until": "2023-01-21",
    "html_description": "<div>Public HTML description visible to partners</div>",
    "is_using_explicit_terms_and_conditions": true,
    "terms_and_conditions": "Updated Offer T&Cs",
    "is_force_terms_and_conditions": true,
    "is_caps_enabled": true,
    "daily_conversion_cap": 200,
    "weekly_conversion_cap": 0,
    "monthly_conversion_cap": 0,
    "global_conversion_cap": 0,
    "daily_payout_cap": 0,
    "weekly_payout_cap": 0,
    "monthly_payout_cap": 0,
    "global_payout_cap": 0,
    "daily_revenue_cap": 0,
    "weekly_revenue_cap": 0,
    "monthly_revenue_cap": 0,
    "global_revenue_cap": 0,
    "daily_click_cap": 0,
    "weekly_click_cap": 0,
    "monthly_click_cap": 0,
    "global_click_cap": 50000,
    "redirect_mode": "standard",
    "is_using_suppression_list": false,
    "suppression_list_id": 0,
    "is_must_approve_conversion": false,
    "is_allow_duplicate_conversion": true,
    "is_duplicate_filter_enabled": true,
    "duplicate_filter_targeting_action": "block",
    "network_tracking_domain_id": 8,
    "is_use_secure_link": true,
    "is_seo_friendly": false,
    "is_allow_deep_link": false,
    "is_session_tracking_enabled": true,
    "session_tracking_start_on": "click",
    "session_tracking_lifespan_hour": 730,
    "session_tracking_minimum_lifespan_second": 60,
    "is_view_through_session_tracking_enabled": false,
    "view_through_session_tracking_lifespan_minute": 0,
    "view_through_session_tracking_minimal_lifespan_second": 0,
    "is_block_already_converted": false,
    "already_converted_action": "unknown",
    "is_fail_traffic_enabled": true,
    "redirect_routing_method": "internal",
    "redirect_internal_routing_type": "priority",
    "visibility": "require_approval",
    "time_created": 1609948152,
    "time_saved": 1609951371,
    "conversion_method": "server_postback",
    "is_whitelist_check_enabled": false,
    "is_use_scrub_rate": false,
    "scrub_rate_status": "null_value",
    "scrub_rate_percentage": 0,
    "session_definition": "cookie",
    "session_duration": 48,
    "app_identifier": "553834731",
    "is_description_plain_text": false,
    "is_use_direct_linking": false,
    "relationship": {
        "category": {
            "network_category_id": 18,
            "network_id": 1,
            "name": "Business",
            "status": "active",
            "time_created": 1489692867,
            "time_saved": 1526478117
        },
        "labels": {
            "total": 2,
            "entries": [
                "label1",
                "label2"
            ]
        },
        "payout_revenue": {
            "total": 3,
            "entries": [
                {
                    "network_offer_payout_revenue_id": 68598,
                    "network_id": 1,
                    "network_offer_id": 1019,
                    "entry_name": "Install",
                    "payout_type": "cpa",
                    "payout_amount": 1.6,
                    "payout_percentage": 0,
                    "revenue_type": "rpa",
                    "revenue_amount": 2,
                    "revenue_percentage": 0,
                    "is_default": true,
                    "is_private": false,
                    "is_postback_disabled": false,
                    "is_enforce_caps": true,
                    "time_created": 1609948152,
                    "global_advertiser_event_id": 0,
                    "is_must_approve_conversion": false,
                    "is_allow_duplicate_conversion": true,
                    "is_email_attribution_default_event": false
                },
                {
                    "network_offer_payout_revenue_id": 68600,
                    "network_id": 1,
                    "network_offer_id": 1019,
                    "entry_name": "Recurring Purchase",
                    "payout_type": "cpa",
                    "payout_amount": 8,
                    "payout_percentage": 0,
                    "revenue_type": "rpa",
                    "revenue_amount": 10,
                    "revenue_percentage": 0,
                    "is_default": false,
                    "is_private": false,
                    "is_postback_disabled": false,
                    "is_enforce_caps": false,
                    "time_created": 1609950849,
                    "global_advertiser_event_id": 0,
                    "is_must_approve_conversion": false,
                    "is_allow_duplicate_conversion": true,
                    "is_email_attribution_default_event": false
                },
                {
                    "network_offer_payout_revenue_id": 68599,
                    "network_id": 1,
                    "network_offer_id": 1019,
                    "entry_name": "Purchase",
                    "payout_type": "cps",
                    "payout_amount": 0,
                    "payout_percentage": 5,
                    "revenue_type": "rps",
                    "revenue_amount": 0,
                    "revenue_percentage": 10,
                    "is_default": false,
                    "is_private": false,
                    "is_postback_disabled": false,
                    "is_enforce_caps": true,
                    "time_created": 1609948152,
                    "global_advertiser_event_id": 0,
                    "is_must_approve_conversion": false,
                    "is_allow_duplicate_conversion": true,
                    "is_email_attribution_default_event": true
                }
            ]
        },
        "thumbnail_asset": {
            "network_asset_id": 1571,
            "content_type": "image/png",
            "filename": "modifications.png",
            "url": "https://assets.efusercontent.com/1/offers/1019/thumb/thumbnail.png",
            "file_size": 129863,
            "image_width": 1313,
            "image_height": 822
        },
        "encoded_value": "2RJ36XN",
        "is_locked_currency": true,
        "channels": {
            "total": 1,
            "entries": [
                {
                    "network_channel_id": 5,
                    "network_id": 1,
                    "name": "Facebook",
                    "status": "active",
                    "time_created": 1583177330,
                    "time_saved": 1583177330
                }
            ]
        },
        "is_locked_caps_timezone": true,
        "meta": {
            "network_offer_id": 1019,
            "network_id": 1,
            "app_id": "553834731",
            "meta_platform": "ios",
            "advertiser_campaign_name": "",
            "bundle_id": "com.midasplayer.apps.candycrushsaga",
            "category": "Games",
            "store_url": "https://apps.apple.com/us/app/candy-crush-saga/id553834731?uo=4&at=10l9yE",
            "score_rating": 4.70797,
            "total_rating": 1785257,
            "size": 225218560,
            "developer": "King.com Limited",
            "version": "1.192.0.1",
            "is_app_unavailable": false,
            "time_created": 1609948153,
            "time_app_data_saved": 1609948414,
            "time_saved": 1609951371
        },
        "requirement_kpis": {
            "total": 0,
            "entries": []
        },
        "requirement_tracking_parameters": {
            "total": 0,
            "entries": []
        }
    },
    "is_email_attribution_enabled": true,
    "email_attribution_method": "last_affiliate_attribution",
    "attribution_method": "last_touch"
}

Docs: Partner Webhooks

Mon, 01 Jan 0001 00:00:00 +0000

Partner webhooks are fired whenever partners are created or updated.

Partner Created

This is only fired when a partner is created at a top level. Creating a new partner user for an existing partner for example will not cause this webhook to fire.

The payload included in the Partner Created webhook is the same one you would receive by making a request to the Find Affiliate By ID endpoint using both the users and billing relationships.

Note that this webhook will not fire when a partner signs up. See the “Partner Signed Up” webhook below.

Payload Example

The payload of the webhook, when using the POST option will look like so :

Payload

{
    "network_affiliate_id": 20138,
    "network_id": 1,
    "name": "Partner Name",
    "account_status": "active",
    "network_employee_id": 10,
    "internal_notes": "Internal Notes",
    "has_notifications": true,
    "network_traffic_source_id": 38,
    "account_executive_id": 39,
    "adress_id": 83932,
    "default_currency_id": "USD",
    "is_contact_address_enabled": true,
    "enable_media_cost_tracking_links": false,
    "time_created": 1609459200,
    "time_saved": 1609459200,
    "relationship": {
        "labels": {
            "total": 2,
            "entries": [
                "label1",
                "label2"
            ]
        },
        "users": {
            "total": 1,
            "entries": [
                {
                    "network_affiliate_user_id": 342,
                    "network_id": 1,
                    "network_affiliate_id": 20138,
                    "first_name": "Partner",
                    "last_name": "User",
                    "email": "partner-user@example.com",
                    "title": "title",
                    "work_phone": "1234567890",
                    "cell_phone": "1234567890",
                    "instant_messaging_id": 0,
                    "instant_messaging_identifier": "",
                    "language_id": 1,
                    "timezone_id": 80,
                    "currency_id": "USD",
                    "account_status": "active",
                    "time_created": 1609459200,
                    "time_saved": 1609459200
                }
            ]
        },
        "account_manager": {
            "first_name": "John",
            "last_name": "Doe",
            "email": "john.doe@example.com",
            "work_phone": "",
            "cell_phone": "",
            "instant_messaging_id": 0,
            "instant_messaging_identifier": ""
        },
        "account_executive": {
            "network_employee_id": 39,
            "network_id": 1,
            "first_name": "Jane",
            "last_name": "Doe",
            "full_name": "Jane Doe",
            "account_status": "inactive"
        },
        "contact_address": {
            "address_id": 83932,
            "network_id": 1,
            "address_1": "4115 Saint-Laurent",
            "address_2": "Suite 202",
            "city": "Montreal",
            "region_code": "QC",
            "country_id": 36,
            "country_code": "CA",
            "zip_postal_code": "H2W 1Y8"
        },
        "encoded_value": "25M87N33",
        "billing": {
            "network_id": 1,
            "network_affiliate_id": 20138,
            "billing_frequency": "bimonthly",
            "payment_type": "paypal",
            "invoice_amount_threshold": 100,
            "tax_id": "TAX_ID_123",
            "is_invoice_creation_auto": true,
            "auto_invoice_start_date": "2020-07-01 00:00:00",
            "default_invoice_is_hidden": false,
            "invoice_generation_days_delay": 10,
            "default_payment_terms": 30,
            "relationship": {
                "paypal_billing": {
                    "paypal_reception_method": "email",
                    "reception_identifier": "partner-user@example.com"
                },
                "bimonthly": {
                    "day_of_month_one": 4,
                    "day_of_month_two": 17
                }
            }
        },
        "network_affiliate_tier_id": 6,
        "ios_app_sources": {
            "total": 0,
            "entries": []
        }
    },
    "referrer_id": 36
}

Partner Updated

This is only fired when the partner itself is updated. For example it will be fired when :

The account manager of the partner is changed to a different one
The partner’s address is updated
The partner’s billing settings are modified

It will not be fired when :

Visibility is granted to the partner over a private offer
A new postback is created for the partner
A partner user is created or updated

The payload included in the Partner Updated webhook is the same one you would receive by making a request to the Find Affiliate 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_affiliate_id": 20138,
    "network_id": 1,
    "name": "Updated Partner Name",
    "account_status": "active",
    "network_employee_id": 10,
    "internal_notes": "Internal Notes",
    "has_notifications": true,
    "network_traffic_source_id": 38,
    "account_executive_id": 39,
    "adress_id": 83932,
    "default_currency_id": "USD",
    "is_contact_address_enabled": true,
    "enable_media_cost_tracking_links": false,
    "time_created": 1609459200,
    "time_saved": 1609459300,
    "relationship": {
        "labels": {
            "total": 2,
            "entries": [
                "label1",
                "label2"
            ]
        },
        "users": {
            "total": 1,
            "entries": [
                {
                    "network_affiliate_user_id": 342,
                    "network_id": 1,
                    "network_affiliate_id": 20138,
                    "first_name": "Partner",
                    "last_name": "User",
                    "email": "partner-user@example.com",
                    "title": "title",
                    "work_phone": "1234567890",
                    "cell_phone": "1234567890",
                    "instant_messaging_id": 0,
                    "instant_messaging_identifier": "",
                    "language_id": 1,
                    "timezone_id": 80,
                    "currency_id": "USD",
                    "account_status": "active",
                    "time_created": 1609459200,
                    "time_saved": 1609459245
                }
            ]
        },
        "account_manager": {
            "first_name": "John",
            "last_name": "Doe",
            "email": "john.doe@example.com",
            "work_phone": "",
            "cell_phone": "",
            "instant_messaging_id": 0,
            "instant_messaging_identifier": ""
        },
        "account_executive": {
            "network_employee_id": 39,
            "network_id": 1,
            "first_name": "Jane",
            "last_name": "Doe",
            "full_name": "Jane Doe",
            "account_status": "inactive"
        },
        "contact_address": {
            "address_id": 83932,
            "network_id": 1,
            "address_1": "4115 Saint-Laurent",
            "address_2": "Suite 202",
            "city": "Montreal",
            "region_code": "QC",
            "country_id": 36,
            "country_code": "CA",
            "zip_postal_code": "H2W 1Y8"
        },
        "encoded_value": "25M87N33",
        "billing": {
            "network_id": 1,
            "network_affiliate_id": 20138,
            "billing_frequency": "bimonthly",
            "payment_type": "paypal",
            "invoice_amount_threshold": 100,
            "tax_id": "TAX_ID_123",
            "is_invoice_creation_auto": true,
            "auto_invoice_start_date": "2020-07-01 00:00:00",
            "default_invoice_is_hidden": false,
            "invoice_generation_days_delay": 10,
            "default_payment_terms": 30,
            "relationship": {
                "paypal_billing": {
                    "paypal_reception_method": "email",
                    "reception_identifier": "partner-user@example.com"
                },
                "bimonthly": {
                    "day_of_month_one": 4,
                    "day_of_month_two": 17
                }
            }
        },
        "network_affiliate_tier_id": 6,
        "ios_app_sources": {
            "total": 0,
            "entries": []
        }
    },
    "referrer_id": 36
}

Partner Signed Up

This is only fired when the partner signs up themself using the partner signup form. Please note that if you enabled email verification for partner signups (Control Center > Configuration > General Tab > Global Settings > Enable Partner Email Verification), the webhook will only fire AFTER the email has been verified.

This webhook will not fire when the partner is created manually inside the Everflow UI.

The payload included in the Partner Signed Up webhook is the same one you would receive by making a request to the Find Affiliate 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_affiliate_id": 20404,
    "network_id": 1,
    "name": "Example Company",
    "account_status": "pending",
    "network_employee_id": 266,
    "internal_notes": "",
    "has_notifications": true,
    "network_traffic_source_id": 0,
    "account_executive_id": 0,
    "adress_id": 84232,
    "default_currency_id": "USD",
    "is_contact_address_enabled": true,
    "enable_media_cost_tracking_links": true,
    "time_created": 1654807370,
    "time_saved": 1654807370,
    "relationship":
    {
        "labels":
        {
            "total": 0,
            "entries":
            []
        },
        "users":
        {
            "total": 1,
            "entries":
            [
                {
                    "network_affiliate_user_id": 609,
                    "network_id": 1,
                    "network_affiliate_id": 20404,
                    "first_name": "Partner",
                    "last_name": "Signup",
                    "email": "partner@example.com",
                    "title": "",
                    "work_phone": "",
                    "cell_phone": "",
                    "instant_messaging_id": 0,
                    "instant_messaging_identifier": "",
                    "language_id": 1,
                    "timezone_id": 80,
                    "currency_id": "USD",
                    "account_status": "active",
                    "time_created": 1654807370,
                    "time_saved": 1654807370
                }
            ]
        },
        "account_manager":
        {
            "first_name": "Network",
            "last_name": "Employee",
            "email": "network-employee@example.com",
            "work_phone": "",
            "cell_phone": "",
            "instant_messaging_id": 0,
            "instant_messaging_identifier": ""
        },
        "sign_up":
        {
            "network_affiliate_id": 20404,
            "network_advertiser_id": 0,
            "website_url": "facebook.com",
            "referral_code": "",
            "advertise_method": "",
            "heard_about_us": "",
            "user_ip": "24.48.56.25",
            "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.5005.61 Safari/537.36",
            "phone": "",
            "tax_id": "VAT Number",
            "legal_type": "unknown",
            "first_name": "Partner",
            "last_name": "Signup",
            "email": "partner@example.com",
            "time_created": 1654807275,
            "relationship":
            {
                "mailing_address":
                {
                    "address_id": 84233,
                    "network_id": 1,
                    "address_1": "7512 Chateaubriand",
                    "address_2": "",
                    "city": "Montreal",
                    "region_code": "QC",
                    "country_id": 36,
                    "country_code": "CA",
                    "zip_postal_code": "H2R 2L1"
                },
                "billing":
                {
                    "network_id": 1,
                    "network_affiliate_id": 20404,
                    "billing_frequency": "bimonthly",
                    "payment_type": "check",
                    "invoice_amount_threshold": 101,
                    "tax_id": "VAT Number",
                    "is_invoice_creation_auto": true,
                    "auto_invoice_start_date": "2022-06-09 20:41:15",
                    "default_invoice_is_hidden": false,
                    "invoice_generation_days_delay": 0,
                    "default_payment_terms": 15,
                    "is_automated_payment_enabled": false,
                    "relationship":
                    {
                        "check_billing":
                        {
                            "recipient_name": "John Doe"
                        },
                        "bimonthly":
                        {
                            "day_of_month_one": 1,
                            "day_of_month_two": 10
                        }
                    }
                },
                "promotional_information":
                [
                    {
                        "network_id": 5,
                        "network_affiliate_id": 20404,
                        "promotional_method": "affiliate",
                        "property_type": "website",
                        "property_type_url": "www.website.com",
                        "promoting_country_ids":
                        [
                            36
                        ]
                    }
                ]
            },
            "network_advertiser_full_name": ""
        },
        "contact_address":
        {
            "address_id": 84232,
            "network_id": 1,
            "address_1": "7512 Chateaubriand",
            "address_2": "",
            "city": "Montreal",
            "region_code": "QC",
            "country_id": 36,
            "country_code": "CA",
            "zip_postal_code": "H2R 2L1"
        },
        "encoded_value": "263BCH8K",
        "billing":
        {
            "network_id": 1,
            "network_affiliate_id": 20404,
            "billing_frequency": "bimonthly",
            "payment_type": "check",
            "invoice_amount_threshold": 101,
            "tax_id": "VAT Number",
            "is_invoice_creation_auto": true,
            "auto_invoice_start_date": "2022-06-09 20:41:15",
            "default_invoice_is_hidden": false,
            "invoice_generation_days_delay": 0,
            "default_payment_terms": 15,
            "is_automated_payment_enabled": false,
            "relationship":
            {
                "check_billing":
                {
                    "recipient_name": "John Doe"
                },
                "bimonthly":
                {
                    "day_of_month_one": 1,
                    "day_of_month_two": 10
                }
            }
        },
        "network_affiliate_tier_id": 28,
        "ios_app_sources":
        {
            "total": 0,
            "entries":
            []
        }
    },
    "referrer_id": 0
}

After a partner signs themselves up using the partner signup form, someone from the network must make a decision (approve or reject the partner). This webhook will fire when that decision occurs.

Note that whenever this webhook fires, the "Partner Updated" webhook documented above will also fire. This webhook is a more minimal version that only fires when that decision is made.

Payload Example

The payload of the webhook, when using the POST option will look like so :

Payload

The new_status will be : active or inactive depending on whether the partner was approved or rejected.

The network employee who made the decision is the one referenced in the payload.

{
    "network_id": 1,
    "network_affiliate_id": 37,
    "network_affiliate_name": "John Doe",
    "new_status": "inactive",
    "employee_id": 1,
    "employee_full_name": "Peter Johnson",
    "timestamp": 1718918402
}

Everflow – Webhooks

Docs: Advertiser Webhooks

Advertiser Created

Payload

Advertiser Updated

Payload

Advertiser Signed Up

Payload

Docs: Offer Webhooks

Offer Created

Payload

Offer Updated

Payload

Docs: Partner Webhooks

Partner Created

Payload

Partner Updated

Payload

Partner Signed Up

Payload

Partner Sign Up Verdict

Payload