Offer Webhooks

Webhooks related to offer data

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.

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.

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