Avid PubSuite Partner API
  1. Outbound Events
Avid PubSuite Partner API
  • Pubsuite API Introduction
  • Getting Started
    • Authentication
    • Response Format
    • Error Codes
    • Usage Limits
  • Endpoints
    • Endpoints / Resources Introduction
    • Global Pubsuite Reference Libaries
    • Workspace Organisation Users
      • Organisation Users List
      • Organisation User By Id
    • Advertiser Accounts
      • Advertiser Accounts List
      • Account Detail
      • Account Delete
      • Account Create
      • Account Update
    • Advertiser Account Members
      • Advertiser Account Members
      • Adv Account Member Detail
      • Account Delete
      • Advertiser Account Member Create
      • Account Update
    • Campaigns
      • Campaign Body Parameters
      • Campaigns
      • Campaign
      • Delete Campaign
      • Campaign Details
      • Update Campaign
    • Phases
      • Phase Body Parameters
      • Phases List
      • Phase
      • Phase Detail
      • Delete Phase
      • Phase Update
    • Content
      • Content Body Parameters
      • Contents
      • Content Detail
      • Create Content
      • Delete Content
      • Update Content
    • Distributions
      • Distribution Body Parameters
      • Distributions List
      • Create Distributions
      • Delete Distribution
      • Distribution Details
      • Distribution Update
    • Publisher Profiles
      • Coming Soon
      • Publisher Profiles
      • Publisher Profile
      • Delete Publisher Profile
    • Publisher Products
      • Coming Soon
    • Data Sources
      • Coming Soon
    • Webhooks
      • Services
      • Create/Update Service
      • Registered Webhooks
      • Create Webhook
      • Update Webhook
      • Delete Webhook
  • Outbound Events
    • Outbound Events
  1. Outbound Events

Outbound Events

Outbound events are notifications or triggers that Avid PubSuite sends to notify external systems or services of changes occurring within the platform. These events provide real-time updates about important actions, such as the creation, update, or deletion of key resources, like campaigns, content, distributions, and users.
By subscribing to these events, you can automate workflows, integrate with third-party systems, or trigger custom business logic based on the actions taken within the platform. Each event corresponds to a specific change in the system and is emitted when the associated action occurs.
In this section, you will find a list of all outbound events available in our platform, including descriptions of what each event signifies and when it is triggered. Use these events to stay informed of important changes in your system and to integrate with other systems seamlessly.

Events#

Campaign Events#

Campaign Created#

campaign_created
When a new campaign is created under an advertiser account. Sends ALL fields in the Campaign object and its sub objects
Event Payload
Event Payload Summary: All Parameters, Reference IDS, All Custom Fields
{
  "event": "campaign_created",
  "timestamp": "<string, ISO 8601 datetime>",
  "data": {
    "campaign_id": "<integer|null>",
    "external_id": "<string>",
    "campaign_status": "<integer>",
    "campaign_workflow_id": "<string>",
    "primary_advertiser_account_id": "<integer>",
    "campaign_title": "<string>",
    "brand_promoting": "<string>",
    "brand_industry_id": "<integer>",
    "brand_sub_industry_id": "<integer>",
    "campaign_description": "<string>",
    "campaign_objective": "<string>",
    "campaign_target_audience_summary": "<string>",
    "no_content_pieces": "<integer>",
    "campaign_gross_cost": "<integer>",
    "campaign_net_cost": "<integer>",
    "media_plan_external_url": "<string, url>",
    "rate_card_external_url": "<string, url>",
    "crm_deal_link": "<string, url>",
    "tracking_report_info": "<string>",
    "using_utm_tracking": "<boolean|integer>",
    "utm_info": "<string>",
    "universal_content_requirements": "<string>",
    "mandatory_dos": "<string>",
    "mandatory_donts": "<string>",
    "content_look_feel_requests": "<string>",
    "additional_audience_targeting_notes": "<string>",
    "additonal_campaign_notes": "<string>",
    "potential_up_sell_opportunities": "<string>",
    "facebook_profile_to_tag": "<string>",
    "instagram_profile_to_tag": "<string>",
    "tiktok_profile_to_tag": "<string>",
    "linkedin_profile_to_tag": "<string>",
    "pinterest_profile_to_tag": "<string>",
    "advertiser_primary_campaign_manager_id": "<integer>",
    "advertiser_primary_campaign_manager_email": "<string>",
    "advertiser_primary_commercial_manager_id": "<integer>",
    "advertiser_primary_commercial_manager_email": "<string>",
    "billing_company_name": "<string>",
    "billing_company_address": "<string>",
    "billing_contact_person": "<string>",
    "billing_contact_email": "<string>",
    "billing_contact_phone": "<string>",
    "purchase_order_number": "<string>",
    "g_impressions": "<integer>",
    "e_impressions": "<integer>",
    "g_article_views": "<integer>",
    "e_article_views": "<integer>",
    "g_clicks_to_site": "<integer>",
    "e_clicks_to_site": "<integer>",
    "g_video_views": "<integer>",
    "e_video_views": "<integer>",
    "custom_fields": {
      "salesforce_opportunity_id": "<integer>",
      "adpoint_order_id": "<integer>",
      "salesforce_opportunity_name": "<string>",
      "adpoint_primary_account_id": "<integer>",
      "salesforce_docs_url": "<string, url>"
    },
    "advertiser_accounts": [{
        "external_id": "<string|null>",
        "advertiser_account_id": "<integer|null>",
        "advertiser_account_type": "<string>",
        "advertiser_account_name": "<string>",
        "custom_fields": {
          "adpoint_organisation_id": "<integer>",
          "adpoint_account_name": "<string>"
        }
      }
    ],
    "campaign_publisher_titles": [
      {
        "external_id": "<string|null>",
        "publisher_title_id": "<integer>",
        "custom_fields": {
          "adpoint_title_id": "<integer>"
        }
      }
    ],
    "workspace_campaign_team": [
      {
        "user_id": "<integer|null>",
        "user_email": "<string>",
        "user_first_name": "<string>",
        "user_last_name": "<string>",
        "roles": [
            "role_type": "<integer>",
            "role_priority": "<integer>"
        ],
        "custom_fields": {
          "full_name": "<string>"
        }
      }
    ],
    "campaign_resources": [
      {
        "user_id": "<integer|null>",
        "user_email": "<string>",
        "advertiser_account_id": "<integer>",
        "user_first_name": "<string>",
        "user_last_name": "<string>",
        "permissions": "<integer>",
        "custom_fields": {
          "adpoint_organisation_id": "<integer>",
          "full_name": "<string>"
        }
      }
    ],
    "campaign_asset_links": [
      {
        "asset_url": "<string, url>",
        "title": "<string>",
        "description": "<string>"
      }
    ],
    "campaign_phases": [
      {
        "external_id": "<string|null>",
        "phase_title": "<string>",
        "phase_description": "<string>",
        "phase_pacing": "<integer>",
        "key_message": "<string>",
        "earliest_phase_launch_date": "<string, date>",
        "latest_phase_launch_date": "<string, date>",
        "earliest_phase_end_date": "<string, date>",
        "latest_phase_end_date": "<string, date>",
        "g_impressions": "<integer>",
        "e_impressions": "<integer>",
        "g_video_views": "<integer>",
        "e_video_views": "<integer>",
        "g_article_views": "<integer>",
        "e_article_views": "<integer>",
        "g_traffic_to_site": "<integer>",
        "e_traffic_to_site": "<integer>",
        "no_of_pieces": "<integer>",
        "custom_fields": {
          "adpoint_burst_name": "<string>"
        },
        "campaign_contents": [
          {
            "external_id": "<string>",
            "publisher_title_id": "<integer>",
            "content_name": "<string>",
            "publisher_product_id": "<integer|null>",
            "status": "<string>",
            "live_date": "<string, date>",
            "content_description": "<string>",
            "content_editor_id": "<integer>",
            "content_editor_email": "<string>",
            "g_impressions": "<integer>",
            "e_impressions": "<integer>",
            "g_video_views": "<integer>",
            "e_video_views": "<integer>",
            "g_article_views": "<integer>",
            "e_article_views": "<integer>",
            "g_traffic_to_site": "<integer>",
            "e_traffic_to_site": "<integer>",
            "custom_fields": {
              "adpoint_publisher_name": "<string>",
              "product_set_id": "<integer>",
              "adpoint_avid_serviced_state_id": "<integer>",
              "salesforce_concepts": "<string>",
              "salesforce_product_goal": "<string>",
              "salesforce_product_goal_info": "<string>",
              "adpoint_informative_line": "<string>",
              "adpoint_inclusions": "<string>",
              "adpoint_required_assets": "<string>"
            },

            "content_distributions": [
              {
                "external_id": "<string>",
                "distribution_type_id": "<integer>",
                "publisher_title_id": "<integer>",
                "status": "<integer>",
                "distirbution_status_slug": "<string>",
                "workflow_id": "<integer>",
                "wf_slug": "<string>",
                "distiribution_class": "<integer>",
                "distribution_label": "<string>",
                "distribution_live_date": "<string, date>",
                "advertiser_review": "<boolean|integer>",
                "no_of_feedback_allowed": "<integer>",
                "preview_url": "<string, url>",
                "content_tile": "<string>",
                "sponsored_tag": "<string>",
                "has_destination_link": "<boolean|integer>",
                "count_clicks_as": "<integer>",
                "amp_start_date": "<string, date>",
                "amp_start_time": "<string, time>",
                "amp_end_date": "<string, date>",
                "placements_setup": "<integer>",
                "custom_placements_platforms": "<integer>",
                "custom_placements_placements": "<integer>",
                "ad_type": "<integer>",
                "ad_banner_button": "<integer>",
                "ad_banner_display_url": "<string, url>",
                "ad_banner_description": "<string>",
                "ad_body_text": "<string>",
                "native_ad_platform": "<integer>",
                "display_ad_type": "<integer>",
                "custom_fields": {
                  "adpoint_line_id": "<integer>",
                  "adpoint_sales_package": "<string>",
                  "adpoint_ad_channel": "<string>",
                  "adpoint_media_channel": "<string>",
                  "adpoint_created_date": "<string, datetime>",
                  "adpoint_changed_date": "<string, datetime>",
                  "adpoint_amplification": "<string>",
                  "adpoint_driving_to_line_no": "<string>",
                  "adpoint_page_post_promoting_line_no": "<string>",
                  "nca_guaranteed_distribution": "<boolean|integer>",
                  "adpoint_line_id_approval_dependency": "<string>"
                },
                "distribution_headline_library": [
                  { "ad_banner_headline": "<string>" }
                ],
                "distribution_links_library": [
                  {
                    "link_type": "<string>",
                    "link_label": "<string, url>",
                    "original_link": "<string, url>",
                    "hyperlink_text": "<string>"
                  }
                ],                "distribution_media_library": [
                  {
                   "is_body_media": "<boolean|integer>",
                    "media_label": "<string>",
                    "file_url": "<string, url>",
                    "media_notes": "<string>"
                  }
                ],
                "distribution_display_assets_library": [
                  {
                    "asset_type": "<string>",
                    "placement_size": "<string>",
                    "tag": "<string>",
                    "media_file_url": "<string, url>",
                    "link_label": "<string>",
                    "original_link": "<string, url>"
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

Campaign Updated#

campaign_updated
When a campaign's details or any of its phase details are modified. Only sends UPDATED fields from the Campaign object or it Phase Objects, and any custom fields
Event Payload
Event Payload Summary: Campaign/Phase Changed Parameters, Reference IDS, All Custom Fields
{
	"event": "campaign_updated",
	"timestamp": "<string, ISO 8601 datetime>",
	"data": {
		"campaign_id": "<integer|null>",
        "external_id": "<string>",
        "campaign_status": "<integer>",
        "campaign_workflow_id": "<string>",
		"<any_updated_fields>": "<string|integer|boolean|null|blank|anyOtherTypeAvailable>",
		"custom_fields": {
 		   	"salesforce_opportunity_id": "<integer>",
            "adpoint_order_id": "<integer>",
            "salesforce_opportunity_name": "<string>",
            "adpoint_primary_account_id": "<integer>",
            "salesforce_docs_url": "<string, url>"		
		},
		"advertiser_accounts": [
			{
                "external_id": "<string|null>",
                "<any_updated_fields>": "<string|integer|boolean|null|blank|anyOtherTypeAvailable>",        				
                "custom_fields": {
                    "adpoint_organisation_id": "<integer>",
                    "adpoint_account_name": "<string>"
                }
            }
		],
		"campaign_publisher_titles": [
            {
                "external_id": "<string|null>",
                "publisher_title_id": "<integer>",
                "custom_fields": {
                    "adpoint_title_id": "<integer>"
                }
            }
		],
		"workspace_campaign_team": [
            {
                "user_id": "<integer|null>",
                "<any_updated_fields>": "<string|integer|boolean|null|blank|anyOtherTypeAvailable>",
                "custom_fields": {
                    "full_name": "<string>"
                }
            }
		],
        "campaign_resources": [
            {
                "user_id": "<integer|null>",
                "<any_updated_fields>": "<string|integer|boolean|null|blank|anyOtherTypeAvailable>",
                "custom_fields": {
                    "adpoint_organisation_id": "<integer>",
                    "full_name": "<string>"
       	 		}
            }
        ],
		"campaign_phases": [
			{
				"external_id": "<string|null>",
				"<any_updated_fields>": "<string|integer|boolean|null|blank|anyOtherTypeAvailable>",
				"custom_fields": {
					"adpoint_burst_name": "<string>"
				}
            }
        ]
      }
}

Campaign Media Added#

campaign_media_added
When new media is associated with a campaign.
Event Payload
Event Payload Summary: All Parameters, Reference IDS
{
    "event": "campaign_media_added",
    "timestamp": "2025-06-06T01:23:45Z",
    "data": {
        "campaign_id": "<integer>",
        "media":[
            {
                "id": "<integer>",
                "media_url": "<string>",
                "media_title": "<string>",
                "media_description": "<string>",
                "...": "all other fields",
            }
        ]
    }                                              
}

Campaign Media Not Added#

campaign_media_not_added
When new media is associated with a campaign.
Event Payload
Event Payload Summary: All Parameters, Reference IDS
{
    "event": "campaign_media_not_added",
    "timestamp": "2025-06-06T01:23:45Z",
    "data": {
        "campaign_id": "<integer>",
        "errors":[
            "Upload failed: Could not determine remote file size of <URL>",
            "Upload failed: Some other message"
        ]
    }                                              
}

Campaign Content Events#

Content Created#

campaign_content_created
When new content is added to a campaign phase.
Event Payload
Event Payload Summary: All Parameters, Reference IDS, All Custom Fields
{
	"event": "content_created",
	"timestamp": "<string, ISO 8601 datetime>",
	"data": {
		"content_id": "<integer>",
		"external_id": "<string|integer>",
		"publisher_product_id": "<integer>",
		"content_name": "<string>",
		"status": "<string>",
		"live_date": "<string>",
		"content_description": "<string>",
		"content_editor_id": "<integer>",
		"content_editor_email": "<string>",
		"publisher_title_id": "<integer>",
		"g_impressions": "<integer>",
		"e_impressions": "<integer>",
		"g_video_views": "<integer>",
		"e_video_views": "<integer>",
		"g_article_views": "<integer>",
		"e_article_views": "<integer>",
		"g_traffic_to_site": "<integer>",
		"e_traffic_to_site": "<integer>",
		"custom_fields": {
		    "adpoint_title_id": "<string>"
		}
	}
}

Content Updated#

content_updated
When content is modified (e.g., publisher title, content name, status) within a campaign phase. Sends all UPDATED paramaters from the content object including its custom fields. Excludes Distribution level information.
Event Payload
Event Payload Summary: Changed Parameters, Reference IDS, All Custom Fields at the Content Object Level. Does NOT include Distributions
{
	"event": "content_updated",
	"timestamp": "<string, ISO 8601 datetime>",
	"data": {
		"content_id": "<integer>",
		"external_id": "<string|integer>",
		"publisher_product_id": "<integer>",
		"<any_updated_fields>": "<string|integer|boolean|null|blank|anyOtherTypeAvailable>",
		"custom_fields": {
 		   "adpoint_title_id": "<string>"
		}
	}
}

Distribution Events#

Distribution Created#

distribution_created
When a new distribution is created for content.
Event Payload
Event Payload Summary: All Parameters, Reference IDS, All Custom Fields
{
	"event": "distribution_created",
	"timestamp": "<string, ISO 8601 datetime>",
	"data": {
        "external_id": "<string>",
        "distribution_type_id": "<integer>",
        "publisher_title_id": "<integer>",
        "status": "<integer>",
        "distirbution_status_slug": "<string>",
        "workflow_id": "<integer>",
        "wf_slug": "<string>",
        "distiribution_class": "<integer>",
        "distribution_label": "<string>",
        "distribution_live_date": "<string, date>",
        "advertiser_review": "<boolean|integer>",
        "no_of_feedback_allowed": "<integer>",
        "preview_url": "<string|url>",
        "content_tile": "<string>",
        "sponsored_tag": "<string>",
        "has_destination_link": "<boolean|integer>",
        "count_clicks_as": "<integer>",
        "amp_start_date": "<string|date>",
        "amp_start_time": "<string|time>",
        "amp_end_date": "<string|date>",
        "placements_setup": "<integer>",
        "custom_placements_platforms": "<integer>",
        "custom_placements_placements": "<integer>",
        "ad_type": "<integer>",
        "ad_banner_button": "<integer>",
        "ad_banner_display_url": "<string|url>",
        "ad_banner_description": "<string>",
        "ad_body_text": "<string>",
        "native_ad_platform": "<integer>",
        "display_ad_type": "<integer>",
        "custom_fields": {
            "adpoint_line_id": "<integer>",
            "adpoint_sales_package": "<string>",
            "adpoint_ad_channel": "<string>",
            "adpoint_media_channel": "<string>",
            "adpoint_created_date": "<string|datetime>",
            "adpoint_changed_date": "<string|datetime>",
            "adpoint_amplification": "<string>",
            "adpoint_driving_to_line_no": "<string>",
            "adpoint_page_post_promoting_line_no": "<string>",
            "nca_guaranteed_distribution": "<boolean|integer>",
            "adpoint_line_id_approval_dependency": "<string>"
        },	
        "distribution_headline_library": [
            { 
                "ad_banner_headline": "<string>" 
            }
        ],
        "distribution_links_library": [
            {
                "id": "<integer>",
                "link_type": "<string>",
                "link_label": "<string|url>",
                "original_link": "<string|url>",
                "hyperlink_text": "<string>"
            }
        ],                
        "distribution_media_library": [
            {
                "id": "<integer>",
                "is_body_media": "<boolean|integer>",
                "media_label": "<string>",
                "file_url": "<string|url>",
                "media_notes": "<string>"
            }
        ],
        "distribution_display_assets_library": [
            {
                "id": "<integer>",
                "asset_type": "<string>",
                "placement_size": "<string>",
                "tag": "<string>",
                "media_file_url": "<string|url>",
                "link_label": "<string>",
                "original_link": "<string|url>"
            }
        ]
    }
}

Distribution Updated#

distribution_updated
When distribution settings or details are modified.
Event Payload
Event Payload Summary: Changed Parameters, Reference IDS, All Custom Fields
{
	"event": "distribution_updated",
	"timestamp": "<string, ISO 8601 datetime>",
	"data": {
		"distribution_id": "<integer>",
		"external_id": "<string|integer>",
		"content_id": "<integer>",
        "campaign_id": "<integer>",
		"<any_updated_fields>": "<string|integer|boolean|null|blank|anyOtherTypeAvailable>",
		"custom_fields": {
            "adpoint_line_id": "<integer>",
            "adpoint_title_id": "<string>",
            "salesforce_opportunity_id": "<integer>",
            "adpoint_order_id": "<integer>"
            "<any_updated_fields>": "<string|integer|boolean|null|blank|anyOtherTypeAvailable>"
		}
	}
}
Previous
Delete Webhook