Skip to content
SynupAPI
Get an API key
EVENTcampaign.sent

Review campaign sent

Event name: campaign.sent

A campaign was launched and invites started going out. 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.campaign_namestringoptionalCampaign name.
data.campaign_typestringoptional"email_sms" or "review_funnel".
data.campaign_scopestringoptional"sms", "email", or "sms_and_email".
Example delivery
{
  "event": "campaign.sent",
  "timestamp": "2026-07-15T09:00:00Z",
  "account_id": 11073,
  "location_id": "279381",
  "data": {
    "campaign_id": "8f3a1c72-1e4b-4d90-9a2e-6b1c0f7a4d21",
    "campaign_name": "Summer Review Push",
    "campaign_type": "email_sms",
    "campaign_scope": "sms_and_email"
  }
}