Campaign recipients added

Webhook

POST

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.

Request

Header Params

Body Params application/json

Example

{
    "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.."
        ]
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://your-api-server.com' \
--header 'X-Synup-Signature: sha256=Base64Signature==' \
--header 'Content-Type: application/json' \
--data '{
    "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.."
        ]
    }
}'

Responses

🟢200

application/json

Your endpoint acknowledges receipt with any 2xx. A non-2xx response or a timeout (>10s) is treated as a failed delivery.

Bodyapplication/json

Example

{}

Modified at 2026-07-15 18:04:40

Review campaign sent

Campaign message status changed