Skip to main content
To use these webhooks, provide Voucherify with an endpoint URL where notifications should be sent.

​
Configuring webhooks

Follow these steps to configure webhooks:
  1. In Voucherify dashboard, go to Project settings.
  2. Scroll down to the Webhooks section.
  3. Click the plus button – Add new webhook.
  4. Choose v2024-01-01 webhook version.
  5. Provide the following details:
    1. Enter the target URL.
    2. Tick the Is active? checkbox.
    3. Select the events you want to receive. If you want to receive all the events, choose Send me all events option.
    4. Click Send test webhook to test your configuration (optional).
    5. Click Create endpoint.
  6. If necessary for authentication reasons, enter the Secret key in your system to receive webhooks from Voucherify.
You can add multiple webhooks to your projects following the steps above. To update webhook details, click the Pencil button – edit. Enter your changes and click Update endpoint. To delete a webhook, click the trash button and click Delete.

​
Re-Enabling a Webhook

To re-enable a disabled webhook:
  1. In the Project settings, go to the General tab.
  2. Scroll down to the Webhooks section.
  3. Edit the specific Webhook.
  4. Click Is active.
  5. Click Update endpoint.

​
Webhooks Available in Project Settings

These webhooks are triggered by the events listed in the Project settings.
Documentation of some of the events is still in progress.
The following events can send a webhook:

​
Project setting webhook payload

The list shows a general structure of a webhook payload set in Project settings. Indented bullet points mean that an object contains further properties or objects.
Voucher published payload example
{
  "id": "whs_ID",
  "project_id": "proj_ID",
  "created_at": "2025-10-16T16:03:23.071Z",
  "type": "voucher.published",
  "data": {
    "customer": {
      "id": "cust_ID",
      "name": "Alex Doe",
      "email": "alex.doe@doe.alex.io",
      "source_id": "4lx-d03",
      "metadata": {
        "acquisition_channel": "Website"
      },
      "object": "customer"
    },
    "campaign": {
      "id": "camp_ID",
      "name": "Autumn-2025",
      "campaign_type": "DISCOUNT_COUPONS",
      "type": "STANDALONE",
      "is_referral_code": false,
      "voucher": {
        "type": "DISCOUNT_VOUCHER",
        "discount": {
          "type": "AMOUNT",
          "amount_off": 100,
          "units": null,
          "effect": "APPLY_TO_ITEMS"
        },
        "gift": null,
        "loyalty_card": null,
        "redemption": {
          "quantity": null,
          "redeemed_quantity": 0
        },
        "code_config": {
          "pattern": "########",
          "length": 8,
          "charset": "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ",
          "prefix": "",
          "postfix": "",
          "min_desired": 1
        }
      },
      "auto_join": false,
      "join_once": false,
      "active": true,
      "category_id": null,
      "category": null,
      "metadata": {},
      "start_date": null,
      "expiration_date": null,
      "description": null,
      "created_at": "2025-10-14T08:45:08.857Z",
      "updated_at": "2025-10-14T12:39:52.798Z",
      "object": "campaign"
    },
    "publication": {
      "id": "pub_ID",
      "object": "publication",
      "created_at": "2025-10-16T16:03:23.065Z",
      "customer_id": "cust_ID",
      "tracking_id": "4lx-d03",
      "metadata": {},
      "channel": "voucherify-web-ui",
      "source_id": "manual-publication-2020-02-02-v01",
      "result": "SUCCESS",
      "customer": {
        "id": "cust_ID",
        "source_id": "4lx-d03",
        "name": "Alex Doe",
        "email": "alex.doe@doe.alex.io",
        "address": null,
        "summary": null,
        "loyalty": null,
        "referrals": null,
        "metadata": {
          "acquisition_channel": "Website"
        },
        "object": "customer"
      },
      "vouchers_id": [
        "v_ID"
      ]
    },
    "voucher": {
      "id": "v_ID",
      "code": "kUs7oM-cOD3",
      "discount": {
        "type": "AMOUNT",
        "amount_off": 100,
        "effect": "APPLY_TO_ITEMS"
      },
      "type": "DISCOUNT_VOUCHER",
      "campaign": "Autumn2025",
      "campaign_id": "camp_ID",
      "is_referral_code": false,
      "holder_id": "cust_ID",
      "category_id": null,
      "active": true,
      "created_at": "2025-10-16T16:02:41.255Z",
      "updated_at": "2025-10-16T16:03:23.070Z",
      "redemption": {
        "quantity": null,
        "redeemed_quantity": 0
      },
      "start_date": null,
      "expiration_date": null,
      "metadata": {},
      "object": "voucher",
      "categories": []
    },
    "created_at": "2025-10-16T16:03:23.071Z"
  },
  "source": {
    "id": "wh_ID",
    "object": "webhook",
    "target_url": "https:/your.url.io"
  },
  "event": {
    "id": "evvou_ID",
    "type": "voucher.published",
    "created_at": "2025-10-16T16:03:23.071Z",
    "entity_id": "v_ID",
    "group_id": "v-ID",
    "event_source": {
      "channel": "USER_PORTAL",
      "user": {
        "id": "user_ID"
      }
    }
  }
}
⌘I