Response body schema for webhook endpoints.
| Name | Type | Description |
|---|---|---|
| id | String | Unique identifier of the webhook. |
| _object | ObjectEnum | The type of the object represented by JSON. |
| createdAt | OffsetDateTime | Timestamp representing the date and time when the webhook configuration was created. The value for this parameter is shown in the ISO 8601 format. |
| targetUrl | String | URL address that receives webhooks. |
| events | List<EventsEnum> | Lists the events that trigger webhook sendout. |
| active | Boolean | Determines if the webhook configuration is active. |
| Name | Value |
|---|---|
| WEBHOOK | "webhook" |
| Name | Value |
|---|---|
| REDEMPTION_SUCCEEDED | "redemption.succeeded" |
| REDEMPTION_FAILED | "redemption.failed" |
| REDEMPTION_ROLLBACK_SUCCEEDED | "redemption.rollback.succeeded" |
| REDEMPTION_ROLLBACK_FAILED | "redemption.rollback.failed" |
| PUBLICATION_SUCCEEDED | "publication.succeeded" |
| VOUCHER_PUBLISHED | "voucher.published" |
| VOUCHER_UPDATED | "voucher.updated" |
| VOUCHER_DELETED | "voucher.deleted" |
| VOUCHER_CREATED | "voucher.created" |
| VOUCHER_ENABLED | "voucher.enabled" |
| VOUCHER_DISABLED | "voucher.disabled" |
| VOUCHER_LOYALTY_CARD_POINTS_ADDED | "voucher.loyalty_card.points_added" |
| VOUCHER_GIFT_BALANCE_ADDED | "voucher.gift.balance_added" |
| CAMPAIGN_ENABLED | "campaign.enabled" |
| CAMPAIGN_DELETED | "campaign.deleted" |
| CAMPAIGN_CREATED | "campaign.created" |
| CAMPAIGN_UPDATED | "campaign.updated" |
| CAMPAIGN_DISABLED | "campaign.disabled" |
| CAMPAIGN_VOUCHERS_GENERATION_COMPLETED | "campaign.vouchers.generation.completed" |
| BUSINESS_VALIDATION_RULE_ASSIGNMENT_CREATED | "business_validation_rule.assignment.created" |
| BUSINESS_VALIDATION_RULE_ASSIGNMENT_DELETED | "business_validation_rule.assignment.deleted" |
| BUSINESS_VALIDATION_RULE_CREATED | "business_validation_rule.created" |
| BUSINESS_VALIDATION_RULE_DELETED | "business_validation_rule.deleted" |
| BUSINESS_VALIDATION_RULE_UPDATED | "business_validation_rule.updated" |
| CUSTOMER_CREATED | "customer.created" |
| CUSTOMER_DELETED | "customer.deleted" |
| CUSTOMER_REWARDED | "customer.rewarded" |
| CUSTOMER_REWARDED_LOYALTY_POINTS | "customer.rewarded.loyalty_points" |