Skip to content
SynupAPI
Get an API key
EVENTcampaign.recipients_added

Campaign recipients added

Event name: campaign.recipients_added

A batch of customers was enrolled into a campaign. Scope: location-scoped. Delivered as a signed HTTP POST to your Webhooks URL.

Every delivery is signed. Verify X-Synup-Signature before processing — see Synup Webhooks.

Payload

NameTypeRequiredDescription
eventstringoptionalDotted event name.
timestampstringoptionalISO-8601 UTC time the event was emitted.
account_idintegeroptionalSynup account the event belongs to.
location_idstringoptionalNumeric string for location-scoped events; null for brand-scoped events.
dataobjectoptional
data.campaign_idstringoptionalCampaign UUID.
data.recipient_countintegeroptionalNumber of recipients enrolled in this batch.
data.review_campaign_customer_idsarray of stringoptionalEnrolled recipient UUIDs.
Example delivery
{
  "event": "campaign.recipients_added",
  "timestamp": "2026-07-15T09:01:30Z",
  "account_id": 11073,
  "location_id": "279381",
  "data": {
    "campaign_id": "8f3a1c72-1e4b-4d90-9a2e-6b1c0f7a4d21",
    "recipient_count": 2,
    "review_campaign_customer_ids": [
      "b1..",
      "c2.."
    ]
  }
}