Deleted

EVENT: "EVENTS.CAMPAIGN.DELETED"

The EVENTS.CAMPAIGN.DELETED event indicates that a specific campaign was removed. This serves as a real-time notification about this event.

📘

Webhook documentation

This page documents only the event. If you need more details about the webhook payload data that includes this event, go to Webhook v2024-01-01 page.

Example: campaign.deleted

JSON

{
  "campaign": {
    "id": "camp_duuYvm09BNsf274eQVp1ZO43",
    "name": "Loyalty Spring",
    "type": "AUTO_UPDATE",
    "active": true,
    "object": "campaign",
    "voucher": {
      "type": "LOYALTY_CARD",
      "redemption": {
        "quantity": null
      },
      "start_date": "2024-02-29T00:00:00.000Z",
      "code_config": {
        "length": 5,
        "prefix": "Loyal-To-Spring",
        "charset": "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ",
        "pattern": "#####"
      },
      "loyalty_card": {
        "points": 0,
        "expiration_rules": {
          "period_type": "MONTH",
          "period_value": 2,
          "rounding_type": "END_OF_QUARTER"
        }
      },
      "expiration_date": "2024-03-31T00:00:00.000Z",
      "is_referral_code": false
    },
    "metadata": {},
    "auto_join": false,
    "join_once": true,
    "protected": false,
    "categories": [],
    "created_at": "2024-02-21T11:35:17.510Z",
    "start_date": "2024-02-29T00:00:00.000Z",
    "updated_at": "2024-02-21T12:16:13.271Z",
    "category_id": "cat_0e156dab8f2e43873a",
    "campaign_type": "LOYALTY_PROGRAM",
    "vouchers_count": 1,
    "creation_status": "DONE",
    "expiration_date": "2024-03-31T00:00:00.000Z",
    "validity_day_of_week": [
      1,
      2,
      3,
      4,
      5
    ],
    "loyalty_tiers_expiration": {
      "start_date": {
        "type": "IMMEDIATE"
      },
      "expiration_date": {
        "type": "CUSTOM",
        "extend": "P2M",
        "rounding": {
          "type": "MONTH",
          "strategy": "END"
        }
      },
      "qualification_type": "BALANCE"
    },
    "vouchers_generation_status": "DONE",
    "use_voucher_metadata_schema": true
  },
  "deleted_at": "2024-02-21T15:29:30.663Z"
}