Create Webhook

Creates a new webhook configuration.

📘 Webhook Documentation

Read Webhooks v2024-01-01 article to learn how webhooks work in Voucherify.

POST /management/v1/projects/{projectId}/webhooks

Create Webhook

cURL

curl --request POST \
  --url https://{cluster}.voucherify.io/management/v1/projects/{projectId}/webhooks \
  --header 'Content-Type: application/json' \
  --data '
{
  "target_url": "<string>",
  "events": [
    "business_validation_rule.assignment.created"
  ],
  "active": true
}
'

200

{
  "object": "webhook",
  "created_at": "2024-04-30T08:13:55.789Z",
  "id": "wh_ekFHVL6lqC4lDuIFxpETSGa3",
  "events": [
    "redemption.succeeded"
  ],
  "target_url": "your_url",
  "active": true
}

Path Parameters

projectId · string · required

Provide the unique identifier of the project.

Example:

"proj_TrlkLiH4"

Body

application/json

Defines a webhook configuration.

Request body schema for POST /management/v1/projects/{projectId}/webhooks/{webhookId}.

target_url · string · required

URL address that receives webhooks.

events · enum<string>[] · required

Lists the events that trigger webhook sendout.

Available options: business_validation_rule.assignment.created, business_validation_rule.assignment.deleted, business_validation_rule.created, business_validation_rule.deleted, business_validation_rule.updated, campaign.created, campaign.deleted, campaign.disabled, campaign.enabled, campaign.earning_rule.assigned, campaign.earning_rule.deleted, campaign.earning_rule.disabled, campaign.earning_rule.enabled, campaign.earning_rule.updated, campaign.loyalty_tier.created, campaign.loyalty_tier.deleted, campaign.loyalty_tier.updated, campaign.promotion_stack.created, campaign.promotion_stack.updated, campaign.promotion_tier.created, campaign.promotion_tier.deleted, campaign.promotion_tier.disabled, campaign.promotion_tier.enabled, campaign.promotion_tier.updated, campaign.referral_tier.created, campaign.referral_tier.deleted, campaign.referral_tier.updated, campaign.reward.assignment.created, campaign.reward.assignment.deleted, campaign.reward.assignment.updated, campaign.updated, campaign.vouchers.aded, campaign.vouchers.generation.completed, campaign.vouchers.generation.failed, campaign.vouchers.generation.started, customer.confirmed, customer.created, customer.deleted, customer.rewarded, customer.rewarded.loyalty_points, publication.succeeded, redemption.failed, redemption.rollback.failed, redemption.rollback.succeeded, redemption.succeeded, voucher.created, voucher.deleted, voucher.disabled, voucher.enabled, voucher.gift.balance_aded, voucher.gift.transaction.created, voucher.loyalty_card.pending_points.activated, voucher.loyalty_card.pending_points.aded, voucher.loyalty_card.pending_points.canceled, voucher.loyalty_card.pending_points.updated, voucher.loyalty_card.points_aded, voucher.loyalty_card.points_expired, voucher.loyalty_card.transaction.created, voucher.published, voucher.updated

active · boolean · default: true

Determines if the webhook configuration is active.

Response

200

application/json

Returns the details about the webhook configuration.

Response body schema for POST /management/v1/projects/{projectId}/webhooks.

id · string · required

Unique identifier of the webhook.

Example:

"wh_i45Uez36Uz8XNW6PXC0eyGmb"

object · enum<string> · default: webhook · required

The type of the object represented by JSON.

Available options: webhook

created_at · string<date-time> · required

Timestamp representing the date and time when the webhook configuration was created. The value for this parameter is shown in the ISO 8601 format.

Example:

"2024-01-02T08:31:46.562Z"

target_url · string · required

URL address that receives webhooks.

events · enum<string>[] · required

Lists the events that trigger webhook sendout.

Available options: business_validation_rule.assignment.created, business_validation_rule.assignment.deleted, business_validation_rule.created, business_validation_rule.deleted, business_validation_rule.updated, campaign.created, campaign.deleted, campaign.disabled, campaign.enabled, campaign.earning_rule.assigned, campaign.earning_rule.deleted, campaign.earning_rule.disabled, campaign.earning_rule.enabled, campaign.earning_rule.updated, campaign.loyalty_tier.created, campaign.loyalty_tier.deleted, campaign.loyalty_tier.updated, campaign.promotion_stack.created, campaign.promotion_stack.updated, campaign.promotion_tier.created, campaign.promotion_tier.deleted, campaign.promotion_tier.disabled, campaign.promotion_tier.enabled, campaign.promotion_tier.updated, campaign.referral_tier.created, campaign.referral_tier.deleted, campaign.referral_tier.updated, campaign.reward.assignment.created, campaign.reward.assignment.deleted, campaign.reward.assignment.updated, campaign.updated, campaign.vouchers.aded, campaign.vouchers.generation.completed, campaign.vouchers.generation.failed, campaign.vouchers.generation.started, customer.confirmed, customer.created, customer.deleted, customer.rewarded, customer.rewarded.loyalty_points, publication.succeeded, redemption.failed, redemption.rollback.failed, redemption.rollback.succeeded, redemption.succeeded, voucher.created, voucher.deleted, voucher.disabled, voucher.enabled, voucher.gift.balance_aded, voucher.gift.transaction.created, voucher.loyalty_card.pending_points.activated, voucher.loyalty_card.pending_points.aded, voucher.loyalty_card.pending_points.canceled, voucher.loyalty_card.pending_points.updated, voucher.loyalty_card.points_aded, voucher.loyalty_card.points_expired, voucher.loyalty_card.transaction.created, voucher.published, voucher.updated

active · boolean · default: true · required

Determines if the webhook configuration is active.