The guide explains how to receive real-time updates about your marketing campaigns. We've written this guide to be clear and accessible, whether you're a developer or a business owner.
Available Events
We support 3 main webhook events for campaign operations:
campaign.created- Triggered when a new campaign is created.campaign.updated- Triggered when a campaign is modified.campaign.deleted- Triggered when a campaign is removed.
Event Details (campaign.created)
This notification happens whenever a new campaign comes to life in your system, signaling its successful creation and activation.
How to Trigger the Event
Through the CRM Campaigns UI:
Add a New Campaign:
Click on Actions → Add Campaign → Fill in the details → Save.
Copy an Existing Campaign:
On a campaign, click on "… → Copy".
Through the APIs:
Note:
Ensure the appropriate action is performed to trigger the campaign.created event. For duplications, verify the copied campaign details.
What Information Will You Receive?
You will receive the campaign ID, campaign details (e.g., name, type), and the timestamp of creation.
Decrypted JSON Encoded Payload
{
"clientAppKey": "app_key_here",
"type": "campaign.created",
"time": "2025-01-01 09:59:44",
"data": {
"id": "d6aeda39-7136-4f29-8ab8-c47d246e061b",
"object": {
"id": 8,
"created_at": "2024-12-30T08:01:37-05:00",
"currency": "USD",
"name": "Campaign-name",
"description": "",
"channel": "Affiliate",
"max_grace_period_attempts": 6,
"offers": [
{
"id": 1,
"name": "Offer01"
},
{
"id": 2,
"name": "Offer02"
}
],
"payment_types": [
"amex",
"visa",
"master"
],
"payment_profile": null,
"countries": [
{
"iso_2": "AR",
"iso_3": "ARG",
"name": "Argentina"
},
{
"iso_2": "TR",
"iso_3": "TUR",
"name": "Turkey"
},
{
"iso_2": "US",
"iso_3": "USA",
"name": "United States of America (the)"
}
],
"shipping_methods": [
{
"id": 2,
"name": "Shipping_Method01"
},
{
"id": 3,
"name": "Shipping_Method02"
}
],
"payment_router": {
"id": 1,
"name": "payment_router01"
},
"tax_profiles": [],
"post_back_profiles": [
{
"id": 8,
"name": "Profile_name",
"url": "your_url_here"
}
],
"return_profiles": [
{
"id": 1,
"name": “return_profile01",
},
{
"id": 2,
"name": “return_profile02",
}
],
"coupon_profiles": [
{
"id": 1,
"name": “Coupon_name01",
},
{
"id": 2,
"name": "coupon_name02"
}
],
"fulfillment_provider": {
"id": 1,
"alias": "fulfillmet_shipment",
"provider": "ShipBob V2"
},
"fraud_providers": [
{
"id": 1,
"alias": “fraud_provider01",
"provider": "Pinpoint"
},
{
"id": 2,
"alias": "fraud_provider02",
"provider": "FraudLogic"
}
],
"prospect_providers": [
{
"id": 1,
"alias":"prospect_provider01",
"provider": "Adjargon"
},
{
"id": 2,
"Alias": "prospect_provider02",
"provider": "AgencyIQ"
}
],
"order_confirmation_provider": {
"id": 1,
"alias": "comfirmation_provider_name",
"provider": "Argo Marketing Group"
},
"chargeback_provider": {
"id": 1,
"alias": "chargeback_provider_name”
"provider": "Ethoca"
},
"membership_provider": {
"id": 1,
"alias": "membership_provider_name",
"provider": "Access Development"
},
"auto_responder_provider": {
"id": 1,
"alias": "response_provider_name",
"provider": "MailChimp",
"prospect_id": "1",
"customer_id": "1"
},
"tax_provider": {
"id": 1,
"alias": "tax_provider_name",
"provider": "Avalara"
},
"data_verification_provider": {
"id": 20,
"alias": "verification_provider_name",
"provider": "CCVerify"
},
"collection_provider": [
{
"id": 1,
"alias": "collection_provider_name",
"provider": "Collect Pros"
}
],
"account_updater_provider": [
{
"id": 1,
"alias": "account_updater_name”,
"provider": "sticky.io"
}
],
"loyalty_provider": [
{
"id": 1,
"alias": "loyality_provider_name",
"provider": "ReferralCandy"
}
],
"is_prepaid_card_blocked": 1,
"bin_blocking_profiles": [
{
"id": 1,
"name": "blocking_profile_1"
},
{
"id": 2,
"name": "blocking_profile_2"
}
],
"is_custom_price_allowed": 1,
"daily_subscription_limit": "2222.00",
"is_collections_enabled": 1,
"is_archived": 0,
"is_active": 1
},
"created": "2025-01-01 09:59:44",
"triggeringEvent": "",
"correlationId": "745f23a9-8729-4f60-b51b-5f3f91f5321c"
}
}
Event Details (campaign.updated)
This notification arrives whenever changes are made to an existing campaign, reflecting updates or modifications to its details.
How to Trigger the Event
Through the CRM Campaigns UI:
Modify a Campaign:
Click on "… → Do your changes → Save".
Change Campaign State:
Disable, Enable, Archive, or Unarchive: Click on "… → Action" or "Actions → Archive" for multiple campaigns.
Through the CRM Coupons UI:
Assign to Campaigns: On a coupon profile, click "… → Assign to Campaigns" (one event per selected campaign).
Through the CRM Providers UI:
Multiple provider types of support "Assign to Campaigns" and "Assign to All Campaigns" actions:
Fulfillment profiles
Risk Mitigation profiles
Prospect profiles
Order Confirmation profiles
Chargeback profiles
Membership profiles
Auto Responder profiles
Tax profiles
Data Verification profiles
Collection profiles
Account Updater profiles
Loyalty profiles
Through the APIs:
What Information Will You Receive?
You will receive the campaign ID, details of the changes made (e.g., state updates, assigned coupons), and the timestamp of the modification.
Decrypted JSON Encoded Payload
{
"clientAppKey": "app_key_here",
"type": "campaign.updated",
"time": "2025-01-01 10:00:33",
"data": {
"id": "93bd1ce5-457d-4acd-b853-8e91a3d8b61e",
"object": {
"id": 8,
"created_at": "2024-12-30T08:01:37-05:00",
"currency": "USD",
"name": "Campaign_name",
"description": "",
"channel": "Affiliate",
"max_grace_period_attempts": 6,
"offers": [
{
"id": 1,
"name": "Offer_1"
},
{
"id": 2,
"name": "Offer_2"
}
],
"payment_types": [
"amex",
"visa",
"master"
],
"payment_profile": null,
"countries": [
{
"iso_2": "AR",
"iso_3": "ARG",
"name": "Argentina"
},
{
"iso_2": "TR",
"iso_3": "TUR",
"name": "Turkey"
},
{
"iso_2": "US",
"iso_3": "USA",
"name": "United States of America (the)"
}
],
"shipping_methods": [
{
"id": 2,
"name": "Shipping_method01"
},
{
"id": 3,
"name": "Shipping_method02"
}
],
"payment_router": {
"id": 1,
"name": "payment_router01"
},
"tax_profiles": [],
"post_back_profiles": [
{
"id": 8,
"name": "Profile_name",
"url": "your_url_here"
}
],
"return_profiles": [
{
"id": 1,
"name": “return_profile01",
},
{
"id": 2,
"name": “return_profile02"
}
],
"coupon_profiles": [
{
"id": 1,
"name": “Coupon_name01",
},
{
"id": 2,
"name": “Coupon_name02"
}
],
"fulfillment_provider": {
"id": 1,
"alias": "fulfillmet_shipment",
"provider": "ShipBob V2"
},
"fraud_providers": [
{
"id": 1,
"alias": “fraud_provider01",
"provider": "Pinpoint"
},
{
"id": 2,
"alias": “fraud_provider02",
"provider": "FraudLogic"
}
],
"prospect_providers": [
{
"id": 1,
"alias": "prospect_provider01",
"provider": "Adjargon"
},
{
"id": 2,
"alias": "prospect_provider02",
"provider": "AgencyIQ"
}
],
"order_confirmation_provider": {
"id": 1,
"alias": "order_confirmation_provider_name",
"provider": "Argo Marketing Group"
},
"chargeback_provider": {
"id": 1,
"alias": "chargeback_provider_name”
"provider": "Ethoca"
},
"membership_provider": {
"id": 1,
"alias": "membership_provider_name",
"provider": "Access Development"
},
"auto_responder_provider": {
"id": 1,
"alias": "response_provider_name",
"provider": "MailChimp",
"prospect_id": "1",
"customer_id": "1"
},
"tax_provider": {
"id": 1,
"alias": "tax_provider_name",
"provider": "Avalara"
},
"data_verification_provider": {
"id": 20,
"alias": "verification_provider_name",
"provider": "CCVerify"
},
"collection_provider": [
{
"id": 1,
"alias": "collection_provider_name",
"provider": "Collect Pros"
}
],
"account_updater_provider": [
{
"id": 1,
"alias": "account_updater_name”,
"provider": "sticky.io"
}
],
"loyalty_provider": [
{
"id": 1,
"alias": "loyality_provider_name",
"provider": "ReferralCandy"
}
],
"is_prepaid_card_blocked": 1,
"bin_blocking_profiles": [
{
"id": 1,
"name": "blocking_profile_1"
},
{
"id": 2,
"name": "blocking_profile_2"
}
],
"is_custom_price_allowed": 1,
"daily_subscription_limit": "2222.00",
"is_collections_enabled": 1,
"is_archived": 0,
"is_active": 1
},
"created": "2025-01-01 10:00:33",
"triggeringEvent": "",
"correlationId": "5a1a573d-aeb3-4875-bb87-b87c8d54823d"
}
}
Event Details (campaign.deleted)
This notification happens when a campaign is permanently removed from your system, indicating its successful deletion.
How to Trigger the Event
Through the CRM Campaigns UI:
Delete a Campaign : Click on "Actions → Delete".
Through the APIs:
Use the V2 API to Delete Campaign endpoints.
What Information Will You Receive?
You will receive the campaign ID, user details, timestamp of deletion, and a success status upon removal of the campaign.
Decrypted JSON Encoded Payload
{
"clientAppKey": "app_key_here",
"type": "campaign.deleted",
"time": "2025-01-01 17:27:13",
"data": {
"id": "69823985-2485-432a-9376-1e2992a83981",
"object": {
"id": 1
}
}
}
Understanding the Payload
Let's break down the important information you'll receive:
name: The campaign's name
description: Any additional details about the campaign
channel: How the campaign is being promoted (e.g., "Affiliate")
currency: The currency used for the campaign
is_active: Whether the campaign is currently running
Payment Settings
payment_types: Accepted payment methods
payment_profile: Special payment settings
daily_subscription_limit: Maximum daily subscription amount
Geographic Settings
countries: List of countries where the campaign is available
Features and Services
offers: Products or services offered in the campaign
shipping_methods: Available shipping options
coupon_profiles: Available discount coupons
fulfillment_provider: How products will be shipped
fraud_providers: Services that help prevent fraud
auto_responder_provider: Email automation services