Webhooks

Get real-time notifications when campaigns and recipients change. Every webhook uses the same envelope; only eventData varies by event type.

Webhook envelope

Every delivery uses this envelope structure:

Envelope structure and field reference

Field	Type	Description
eventId	string	Unique per delivery — use for idempotency / deduplication
webhookId	string	The subscription ID that triggered this delivery
eventType	string	Dot-notation event name (e.g. `campaign.created`)
orgId	string	Organization ID the event belongs to
userId	string	User ID who triggered the action
eventData	object	Event-specific payload — schema is fixed per `eventType`
resourceId	object	Primary resource: `resource` (`campaign` \| `recipient`) and `resourceId`

Example envelope:

{
  "eventId": "whevt-V1StGXR8_Z5jdHi6B-myT",
  "webhookId": "wh_sub_abc123",
  "eventType": "campaign.created",
  "orgId": "org_abc123",
  "userId": "user_789",
  "eventData": { ... },
  "resourceId": { "resource": "campaign", "resourceId": "camp-456" }
}

Supported event types

#	Event Type	Resource	Description
1	`campaign.created`	campaign	A new campaign was created
2	`campaign.updated`	campaign	Campaign fields were modified
3	`campaign.status_changed`	campaign	Campaign status transitioned
4	`campaign.deleted`	campaign	Campaign was deleted
5	`campaign.recipients_added`	campaign	Recipients were added to a campaign
6	`recipient.created`	recipient	A new recipient was added
7	`recipient.status_changed`	recipient	Recipient status transitioned
8	`recipient.email_sent`	recipient	An email was sent to a recipient
9	`recipient.feedback_submitted`	recipient	Recipient submitted feedback

Campaign events

Schema and examples for campaign lifecycle events.

Recipient events

Schema and examples for recipient and delivery events.

Campaign events

campaign.created

Fired when a new campaign is created.eventData schema:

Field	Type	Required	Description
campaignId	string	yes	Campaign ID
name	string	yes	Campaign name
description	string	no	Campaign description
status	string	yes	e.g. `draft`, `preparing`, `live`, `completed`
createdBy	string	yes	User ID of creator
createdAt	string (ISO 8601)	no	Creation timestamp
goal	object	no	`{ goalId, name }`
motion	object	no	`{ motionId, name }`
budget	object	no	`{ totalAmount, currency }`
target_recipient_count	number	yes	Target/expected recipient count
recipient_in_camp	number	yes	Actual count
recipient_details	array	yes	`[{ fname, lname, email }]`

Example:

{
  "eventId": "whevt-V1StGXR8_Z5jdHi6B-myT",
  "webhookId": "wh_sub_abc123",
  "eventType": "campaign.created",
  "orgId": "org_abc123",
  "userId": "user_789",
  "eventData": {
    "campaignId": "camp-456",
    "name": "Q4 Enterprise Outreach",
    "description": "Q4 outreach for enterprise accounts",
    "status": "draft",
    "createdBy": "user_789",
    "createdAt": "2025-12-23T11:00:00Z",
    "goal": { "goalId": "goal_1", "name": "Enterprise Gifting" },
    "motion": { "motionId": "motion_1", "name": "Holiday Campaign" },
    "budget": { "totalAmount": 50000, "currency": "USD" },
    "target_recipient_count": 100,
    "recipient_in_camp": 100,
    "recipient_details": [
      { "fname": "John", "lname": "Doe", "email": "john@example.com" }
    ]
  },
  "resourceId": { "resource": "campaign", "resourceId": "camp-456" }
}

campaign.updated

Fired when one or more campaign fields are modified.eventData schema:

Field	Type	Required	Description
campaignId	string	yes	Campaign ID
name	string	no	Current name
description	string	no	Current description
status	string	yes	Current status
lastUpdatedBy	string	no	User ID who performed update
updatedAt	string (ISO 8601)	no	Update timestamp
goal	object	no	`{ goalId, name }`
motion	object	no	`{ motionId, name }`
budget	object	no	`{ totalAmount, currency }`
fieldChanges	array	yes	`[{ field, previousValue, newValue }]`

Example:

{
  "eventId": "whevt-KpR2xYZ7_A3bNq9C-def",
  "webhookId": "wh_sub_abc123",
  "eventType": "campaign.updated",
  "orgId": "org_abc123",
  "userId": "user_789",
  "eventData": {
    "campaignId": "camp-456",
    "name": "Q4 Enterprise Outreach v2",
    "status": "draft",
    "lastUpdatedBy": "user_789",
    "updatedAt": "2025-12-24T09:30:00Z",
    "fieldChanges": [
      { "field": "name", "previousValue": "Q4 Enterprise Outreach", "newValue": "Q4 Enterprise Outreach v2" },
      { "field": "budget.totalAmount", "previousValue": 50000, "newValue": 75000 }
    ]
  },
  "resourceId": { "resource": "campaign", "resourceId": "camp-456" }
}

campaign.status_changed

Fired when a campaign transitions from one status to another.eventData schema:

Field	Type	Required	Description
campaignId	string	yes	Campaign ID
name	string	yes	Campaign name
previousStatus	string	yes	Status before change
currentStatus	string	yes	Status after change
statusChangedBy	string	yes	User ID who changed status
statusChangedAt	string (ISO 8601)	yes	When status changed

Example:

{
  "eventId": "whevt-Lm8nOPQ1_R4cDs5E-ghi",
  "webhookId": "wh_sub_abc123",
  "eventType": "campaign.status_changed",
  "orgId": "org_abc123",
  "userId": "user_789",
  "eventData": {
    "campaignId": "camp-456",
    "name": "Q4 Enterprise Outreach v2",
    "previousStatus": "draft",
    "currentStatus": "live",
    "statusChangedBy": "user_789",
    "statusChangedAt": "2025-12-25T08:00:00Z"
  },
  "resourceId": { "resource": "campaign", "resourceId": "camp-456" }
}

campaign.deleted

Fired when a campaign is deleted.eventData schema:

Field	Type	Required	Description
campaignId	string	yes	Campaign ID
name	string	no	Campaign name at delete time
status	string	yes	Status at delete time
deletedBy	string	no	User ID who deleted
deletedAt	string (ISO 8601)	yes	When deleted

Example:

{
  "eventId": "whevt-Wx9yZAB2_C5dEf6G-jkl",
  "webhookId": "wh_sub_abc123",
  "eventType": "campaign.deleted",
  "orgId": "org_abc123",
  "userId": "user_789",
  "eventData": {
    "campaignId": "camp-456",
    "name": "Q4 Enterprise Outreach v2",
    "status": "draft",
    "deletedBy": "user_789",
    "deletedAt": "2026-01-10T14:00:00Z"
  },
  "resourceId": { "resource": "campaign", "resourceId": "camp-456" }
}

campaign.recipients_added

Fired when recipients are added to a campaign (manually, bulk upload, or booth QR).eventData schema:

Field	Type	Required	Description
campaignId	string	yes	Campaign ID
campaignName	string	no	Campaign name
campaignStatus	string	yes	Current campaign status
recipientsAdded.count	number	yes	Number of recipients added
recipientsAdded.recipientIds	string[]	no	IDs of added recipients
recipientsAdded.recipient_details	array	no	`[{ fname, lname, email }]`
recipientsAdded.addedBy	string	no	User ID who added
recipientsAdded.addedAt	string (ISO 8601)	yes	When recipients were added

Example:

{
  "eventId": "whevt-Gh3iJKL4_M6nOp7Q-mno",
  "webhookId": "wh_sub_abc123",
  "eventType": "campaign.recipients_added",
  "orgId": "org_abc123",
  "userId": "user_789",
  "eventData": {
    "campaignId": "camp-456",
    "campaignName": "Q4 Enterprise Outreach v2",
    "campaignStatus": "live",
    "recipientsAdded": {
      "count": 2,
      "recipientIds": ["rec-101", "rec-102"],
      "recipient_details": [
        { "fname": "Alice", "lname": "Smith", "email": "alice@example.com" },
        { "fname": "Bob", "lname": "Johnson", "email": "bob@example.com" }
      ],
      "addedBy": "user_789",
      "addedAt": "2025-12-26T10:00:00Z"
    }
  },
  "resourceId": { "resource": "campaign", "resourceId": "camp-456" }
}

Recipient events

recipient.created

Fired when a new recipient is added to a campaign.eventData schema:

Field	Type	Required	Description
recipientId	string	yes	Recipient ID
campaignId	string	yes	Campaign ID
contactDetails	object	yes	`{ firstName, lastName, email }`
sourceType	string	yes	How added: `manual`, `bulk`, `booth`, etc.
status	string	yes	Initial status (e.g. `draft`)
gift	object	no	Gift data: `gifts[]`, `giftBudget`, `giftExpirationDate`, `giftMode`, `selectedCatalogId`
createdAt	string (ISO 8601)	yes	When the recipient was created

eventData.gift.gifts[] (each item): id, name, description, imageUrl, price, currency, budgetExample (single gift):

{
  "eventId": "whevt-Rs8tUVW5_X7yZa9B-pqr",
  "webhookId": "wh_sub_abc123",
  "eventType": "recipient.created",
  "orgId": "org_abc123",
  "userId": "user_789",
  "eventData": {
    "recipientId": "rec-101",
    "campaignId": "camp-456",
    "contactDetails": {
      "firstName": "Alice",
      "lastName": "Smith",
      "email": "alice@example.com"
    },
    "sourceType": "manual",
    "status": "draft",
    "gift": {
      "gifts": [
        {
          "id": "gift-d584a61e-9bb4-473f-8ede-a8bb5debbd95",
          "name": "Premium Gift Box",
          "price": 120,
          "currency": "USD",
          "budget": 120
        }
      ],
      "giftBudget": 120,
      "giftExpirationDate": "2026-03-07",
      "giftMode": "one-gift-for-all",
      "selectedCatalogId": "default"
    },
    "createdAt": "2025-12-26T10:00:00Z"
  },
  "resourceId": { "resource": "recipient", "resourceId": "rec-101" }
}

recipient.status_changed

Fired when a recipient’s status transitions (e.g. draft → invite_sent → address_confirmed → in_transit → delivered).eventData schema:

Field	Type	Required	Description
recipientId	string	yes	Recipient ID
campaignId	string	yes	Campaign ID
previousStatus	string	yes	Status before change
currentStatus	string	yes	Status after change
statusChangedAt	string (ISO 8601)	yes	When status changed
contactDetails	object	no	`{ firstName, lastName, email }`
shipmentInfo	object	no	Shipment details (no `status` field)
carrierDetails	object	no	When `currentStatus` is `in_transit`: `{ name, trackingId, trackingUrl }`

Example (status → in_transit):

{
  "eventId": "whevt-Cd2eFGH6_I8jKl0M-stu",
  "webhookId": "wh_sub_abc123",
  "eventType": "recipient.status_changed",
  "orgId": "org_abc123",
  "userId": "user_789",
  "eventData": {
    "recipientId": "rec-101",
    "campaignId": "camp-456",
    "previousStatus": "address_confirmed",
    "currentStatus": "in_transit",
    "statusChangedAt": "2025-12-28T15:30:00Z",
    "contactDetails": {
      "firstName": "Alice",
      "lastName": "Smith",
      "email": "alice@example.com"
    },
    "carrierDetails": {
      "name": "FedEx",
      "trackingId": "FEDEX123456789",
      "trackingUrl": "https://fedex.com/track/FEDEX123456789"
    }
  },
  "resourceId": { "resource": "recipient", "resourceId": "rec-101" }
}

recipient.email_sent

Fired when any email is sent to a recipient (invite, confirmation, reminder, etc.).eventData schema:

Field	Type	Required	Description
recipientId	string	yes	Recipient ID
campaignId	string	yes	Campaign ID
contactDetails	object	yes	`{ firstName, lastName, email }`
emailType	string	yes	e.g. `invite_sent`, `address_confirmed`, `reminder`
sentAt	string (ISO 8601)	yes	When email was sent

Example:

{
  "eventId": "whevt-Ab5cDEF8_G0hIj2K-yza",
  "webhookId": "wh_sub_abc123",
  "eventType": "recipient.email_sent",
  "orgId": "org_abc123",
  "userId": "user_789",
  "eventData": {
    "recipientId": "rec-101",
    "campaignId": "camp-456",
    "contactDetails": {
      "firstName": "Alice",
      "lastName": "Smith",
      "email": "alice@example.com"
    },
    "emailType": "invite_sent",
    "sentAt": "2025-12-26T10:05:00Z"
  },
  "resourceId": { "resource": "recipient", "resourceId": "rec-101" }
}

recipient.feedback_submitted

Fired when a recipient submits feedback (rating, text, video, or audio).eventData schema:

Field	Type	Required	Description
recipientId	string	yes	Recipient ID
campaignId	string	yes	Campaign ID
contactDetails	object	yes	`{ firstName, lastName, email }`
feedback.rating	object	no	`{ value: "like" \| "dislike", submittedAt }`
feedback.message	object	no	`{ type: "video" \| "audio" \| "text", url?, text?, submittedAt }`
submittedAt	string (ISO 8601)	yes	When feedback was submitted

Example (rating + text):

{
  "eventId": "whevt-Lm3nOPQ9_R1sTu4V-bcd",
  "webhookId": "wh_sub_abc123",
  "eventType": "recipient.feedback_submitted",
  "orgId": "org_abc123",
  "userId": "user_789",
  "eventData": {
    "recipientId": "rec-101",
    "campaignId": "camp-456",
    "contactDetails": {
      "firstName": "Alice",
      "lastName": "Smith",
      "email": "alice@example.com"
    },
    "feedback": {
      "rating": { "value": "like", "submittedAt": "2026-01-02T09:00:00Z" },
      "message": {
        "type": "text",
        "text": "Loved the gift! Thank you so much!",
        "submittedAt": "2026-01-02T09:00:30Z"
      }
    },
    "submittedAt": "2026-01-02T09:00:30Z"
  },
  "resourceId": { "resource": "recipient", "resourceId": "rec-101" }
}

Important notes

Idempotency: Use eventId to deduplicate. It is unique per delivery.

All timestamps are ISO 8601 in UTC.
carrierDetails appears on recipient.status_changed only when currentStatus is in_transit.
feedback.rating.value is "like" or "dislike". feedback.message.type is "video", "audio", or "text".

Need help? Visit the support portal or contact DelightLoop support.

Getting Started

Concepts

Use Cases

Webhook envelope

Supported event types

Campaign events

Recipient events

Campaign events

Recipient events

Important notes

Getting Started

Concepts

Use Cases

​Webhook envelope

​Supported event types

Campaign events

Recipient events

​Campaign events

​Recipient events

​Important notes

Webhook envelope

Supported event types

Campaign events

Recipient events

Important notes