Webhooks
Webhooks are HTTP callbacks that receive notification messages for events. To create a webhook you should configure a webhook listener and subscribe it to events. A webhook listener is a server that listens at a specific URL for incoming HTTP POST notification messages that are triggered when events occur.
It's possible to specify hmacKey for webhook and we will add a x-vivenu-signature header in order to enable you to verify that the request is authentic and signed with your webhook secret.
We strongly recommend to verify the signature in order to prevent malicious users to send webhook requests.
Endpoints
Create a new webhook
Payload
name
Required
string
An internal name to identify the webhook listener
url
Required
string uri
An URL to post the webhook data
Optional Attributes
Collapse allResponses
201
Created
400
Bad Request
401
Unauthorized
post
/api/webhooks
{"name": "string","enabled": true,"url": "https://vivenu.com","events": {"transaction.complete": true,"transaction.reservedBySystem": true,"transaction.canceled": true,"transaction.partiallyCanceled": true,"checkout.completed": true,"checkout.aborted": true,"checkout.detailsSubmitted": true,"ticket.created": true,"ticket.updated": true,"purchaseIntent.created": true,"purchaseIntent.approved": true,"purchaseIntent.rejected": true,"purchaseIntent.updated": true,"purchaseIntent.expired": true,"purchaseIntent.completed": true,"purchaseIntent.cancelled": true,"customer.created": true,"customer.updated": true,"event.created": true,"event.updated": true,"event.deleted": true,"job.started": true,"job.failed": true,"job.completed": true,"support.assignedToSeller": true,"ticketTransfer.created": true,"ticketTransfer.rejected": true,"ticketTransfer.transferred": true,"ticketTransfer.expired": true,"scan.created": true,"bundle.created": true,"bundle.updated": true,"product.created": true,"product.updated": true,"product.deleted": true},"hmacKey": "string"}
Response
application/json
{"_id": "string","name": "string","enabled": true,"url": "https://vivenu.com","events": {"transaction.complete": true,"transaction.reservedBySystem": true,"transaction.canceled": true,"transaction.partiallyCanceled": true,"checkout.completed": true,"checkout.aborted": true,"checkout.detailsSubmitted": true,"ticket.created": true,"ticket.updated": true,"purchaseIntent.created": true,"purchaseIntent.approved": true,"purchaseIntent.rejected": true,"purchaseIntent.updated": true,"purchaseIntent.expired": true,"purchaseIntent.completed": true,"purchaseIntent.cancelled": true,"customer.created": true,"customer.updated": true,"event.created": true,"event.updated": true,"event.deleted": true,"job.started": true,"job.failed": true,"job.completed": true,"support.assignedToSeller": true,"ticketTransfer.created": true,"ticketTransfer.rejected": true,"ticketTransfer.transferred": true,"ticketTransfer.expired": true,"scan.created": true,"bundle.created": true,"bundle.updated": true,"product.created": true,"product.updated": true,"product.deleted": true},"hmacKey": "string","createdBy": {"type": "USER","id": "string"}}
Update a webhook
Payload
name
Required
string
An internal name to identify the webhook listener
url
Required
string uri
An URL to post the webhook data
Optional Attributes
Collapse allResponses
201
Created
400
Bad Request
401
Unauthorized
put
/api/webhook/{id}
{"name": "string","enabled": true,"url": "https://vivenu.com","events": {"transaction.complete": true,"transaction.reservedBySystem": true,"transaction.canceled": true,"transaction.partiallyCanceled": true,"checkout.completed": true,"checkout.aborted": true,"checkout.detailsSubmitted": true,"ticket.created": true,"ticket.updated": true,"purchaseIntent.created": true,"purchaseIntent.approved": true,"purchaseIntent.rejected": true,"purchaseIntent.updated": true,"purchaseIntent.expired": true,"purchaseIntent.completed": true,"purchaseIntent.cancelled": true,"customer.created": true,"customer.updated": true,"event.created": true,"event.updated": true,"event.deleted": true,"job.started": true,"job.failed": true,"job.completed": true,"support.assignedToSeller": true,"ticketTransfer.created": true,"ticketTransfer.rejected": true,"ticketTransfer.transferred": true,"ticketTransfer.expired": true,"scan.created": true,"bundle.created": true,"bundle.updated": true,"product.created": true,"product.updated": true,"product.deleted": true},"hmacKey": "string"}
Response
application/json
{"_id": "string","name": "string","enabled": true,"url": "https://vivenu.com","events": {"transaction.complete": true,"transaction.reservedBySystem": true,"transaction.canceled": true,"transaction.partiallyCanceled": true,"checkout.completed": true,"checkout.aborted": true,"checkout.detailsSubmitted": true,"ticket.created": true,"ticket.updated": true,"purchaseIntent.created": true,"purchaseIntent.approved": true,"purchaseIntent.rejected": true,"purchaseIntent.updated": true,"purchaseIntent.expired": true,"purchaseIntent.completed": true,"purchaseIntent.cancelled": true,"customer.created": true,"customer.updated": true,"event.created": true,"event.updated": true,"event.deleted": true,"job.started": true,"job.failed": true,"job.completed": true,"support.assignedToSeller": true,"ticketTransfer.created": true,"ticketTransfer.rejected": true,"ticketTransfer.transferred": true,"ticketTransfer.expired": true,"scan.created": true,"bundle.created": true,"bundle.updated": true,"product.created": true,"product.updated": true,"product.deleted": true},"hmacKey": "string","createdBy": {"type": "USER","id": "string"}}
Delete a Webhook
Query
No supported query parameters
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found
delete
/api/webhook/{id}
Response
application/json
{"_id": "string","name": "string","enabled": true,"url": "https://vivenu.com","events": {"transaction.complete": true,"transaction.reservedBySystem": true,"transaction.canceled": true,"transaction.partiallyCanceled": true,"checkout.completed": true,"checkout.aborted": true,"checkout.detailsSubmitted": true,"ticket.created": true,"ticket.updated": true,"purchaseIntent.created": true,"purchaseIntent.approved": true,"purchaseIntent.rejected": true,"purchaseIntent.updated": true,"purchaseIntent.expired": true,"purchaseIntent.completed": true,"purchaseIntent.cancelled": true,"customer.created": true,"customer.updated": true,"event.created": true,"event.updated": true,"event.deleted": true,"job.started": true,"job.failed": true,"job.completed": true,"support.assignedToSeller": true,"ticketTransfer.created": true,"ticketTransfer.rejected": true,"ticketTransfer.transferred": true,"ticketTransfer.expired": true,"scan.created": true,"bundle.created": true,"bundle.updated": true,"product.created": true,"product.updated": true,"product.deleted": true},"hmacKey": "string","createdBy": {"type": "USER","id": "string"}}
Get all webhooks
Query
top
Optional
integer
A limit on the number of objects to be returned. Can range between 1 and 1000.
skip
Optional
integer
The number of objects to skip for the requested result
Responses
200
OK
400
Bad Request
401
Unauthorized
get
/api/webhooks
Response
application/json
{"docs": [{"_id": "string","name": "string","enabled": true,"url": "https://vivenu.com","events": {"transaction.complete": true,"transaction.reservedBySystem": true,"transaction.canceled": true,"transaction.partiallyCanceled": true,"checkout.completed": true,"checkout.aborted": true,"checkout.detailsSubmitted": true,"ticket.created": true,"ticket.updated": true,"purchaseIntent.created": true,"purchaseIntent.approved": true,"purchaseIntent.rejected": true,"purchaseIntent.updated": true,"purchaseIntent.expired": true,"purchaseIntent.completed": true,"purchaseIntent.cancelled": true,"customer.created": true,"customer.updated": true,"event.created": true,"event.updated": true,"event.deleted": true,"job.started": true,"job.failed": true,"job.completed": true,"support.assignedToSeller": true,"ticketTransfer.created": true,"ticketTransfer.rejected": true,"ticketTransfer.transferred": true,"ticketTransfer.expired": true,"scan.created": true,"bundle.created": true,"bundle.updated": true,"product.created": true,"product.updated": true,"product.deleted": true},"hmacKey": "string","createdBy": {"type": "USER","id": "string"}}],"total": 1}
Webhook Events
| Event | Trigger | Payload |
|---|---|---|
transaction.complete | When a transaction transitions to COMPLETE | Link |
transaction.reservedBySystem | When a transaction is created RESERVED_BY_SYSTEM | Link |
transaction.canceled | When a transaction transitions to CANCELED | Link |
checkout.completed | When a checkout transitions to COMPLETE | Link |
checkout.aborted | When a checkout transitions to ABORTED | Link |
checkout.detailsSubmitted | When a checkout receives customer details | Link |
ticket.created | When a ticket is created | Link |
ticket.updated | When a ticket is updated | Link |
purchaseIntent.created | When a purchase intent is created | Link |
purchaseIntent.updated | When a purchase intent is updated | Link |
purchaseIntent.completed | When a purchase intent is completed | Link |
purchaseIntent.approved | When a purchase intent is approved | Link |
purchaseIntent.rejected | When a purchase intent is rejected | Link |
purchaseIntent.expired | When a purchase intent is expired | Link |
purchaseIntent.cancelled | When a purchase intent is cancelled | Link |
customer.created | When a customer was created | Link |
customer.updated | When a customer was updated | Link |
event.created | When a event was created | Link |
event.updated | When a event was updated | Link |
event.deleted | When a event was deleted | Link |
job.started | When a job was started | Link |
job.failed | When a job was failed | Link |
job.completed | When a job was completed | Link |
support.assignedToSeller | When a support ticket was assigned to seller | Link |
ticketTransfer.created | When a ticket transfer is created | Link |
ticketTransfer.rejected | When a ticket transfer is rejected | Link |
ticketTransfer.transferred | When a ticket transfer is transferred | Link |
ticketTransfer.expired | When a ticket transfer is expired | Link |
scan.created | When a scan is created | Link |
bundle.created | When a bundle is created | Link |
bundle.updated | When a bundle is updated | Link |
product.created | When a product is created | Link |
product.updated | When a product is updated | Link |
product.deleted | When a product is deleted | Link |
Webhook Payload
The object posted to your listener server. Each event has an individual data object. Examples of these data objects are listed below.
Attributes
mode
Required
string
The mode of the service sending this webhook
devprodOptional Attributes
Collapse allExample
{"id": "string","type": "transaction.complete","mode": "dev","data": {}}
transaction.complete
The data of the transaction complete webhook event.
Attributes
transaction
Required
tickets
Required
array<any>
An array of the tickets associated to this transaction
Example
{"transaction": {"_id": "string","sellerId": "string","customerId": "string","eventId": "string","company": "string","name": "string","prename": "string","lastname": "string","street": "string","line2": "string","city": "string","state": "string","country": "string","postal": "string","deliveryAddress": {"street": "string","line2": "string","postal": "string","city": "string","country": "string","state": "string","name": "string"},"tickets": [],"products": [],"additionalItems": [],"currency": "EUR","regularPrice": 10.5,"realPrice": 10.5,"paymentCharge": 10.5,"innerCharge": 10.5,"outerCharge": 10.5,"innerFeeComponents": {"_id": "string","fix": [{"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}],"var": [{"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}]},"outerFeeComponents": {"_id": "string","fix": [{"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}],"var": [{"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}]},"cancellationFee": {"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}},"cancellationInfo": {"cancellableItems": [{"cartItemId": "string","type": "ticket","name": "string","price": 10.5,"taxRate": 10.5,"origin": {"fee": {"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}},"cancellationFee": {"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}},"refundId": "string","cancelledAt": "2030-01-23T23:00:00.123Z"}]},"taxRate": 0.19,"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z","status": "NEW","psp": "string","paymentMethod": "adyen","paymentInfo": {"_id": "string","psp": "string","gateway": "managed","providerType": "vivenu","providerId": "string","method": "string","methodVariant": "string","locale": "string","riskLevel": "string","riskScore": 10.5,"refundId": "string","collectedApplicationFee": 10.5},"paymentStatus": "AWAITING","origin": "yourticket","userId": "string","posId": "string","posInfo": {"_id": "string","sessionId": "string","billingNo": "string","taxId": "string","paymentMethod": "cash","canceledAt": "2030-01-23T23:00:00.123Z","cancellationNo": "2030-01-23T23:00:00.123Z"},"history": [{"_id": "string","date": "2030-01-23T23:00:00.123Z","title": "string","message": "string","type": "YOURTICKET","risk": "NEUTRAL"}],"historyEntries": [{"_id": "string","date": "2030-01-23T23:00:00.123Z","userId": "string","data": {},"type": "created","risk": "NEUTRAL"}],"ticketMailSend": true,"orderMailSend": true,"extraFields": {},"channel": "string","underShop": "string","userAgent": {"_id": "string","ua": "string","browser": {},"device": {},"engine": {},"os": {},"cpu": {}},"ipLookup": {"ip": "string","lookup": {"range": [10.5],"country": "string","region": "string","eu": "string","timezone": "string","city": "string","ll": [10.5],"metro": 10.5,"area": 10.5}},"locationCenter": [10.5],"secret": "string","vouchers": ["string"],"redeemedVouchers": {"totalRedeemedAmount": 10.5,"vouchers": [{"_id": "string","code": "string","redeemedAmount": 10.5}]},"appliedCoupons": [{"_id": "string","code": "string"}],"appliedDiscountGroups": ["string"],"posDiscounts": [{"_id": "string","name": "string","discountType": "fix","value": 10.5}],"preferredLanguage": "de","cancellationReason": "REQUESTED_BY_CUSTOMER","appliedDiscountInfo": {"items": [{"_id": "string","itemId": "string","amount": 10.5,"regularPrice": 10.5,"price": 10.5,"varDiscounts": [{"_id": "string","discountId": "string","category": "coupon","name": "string","type": "fix","value": 10.5,"allowedItems": ["string"]}],"fixDiscounts": [{"_id": "string","discountId": "string","category": "coupon","name": "string","type": "fix","value": 10.5,"allowedItems": ["string"]}]}],"discounts": [{"_id": "string","discountId": "string","category": "coupon","name": "string","type": "fix","value": 10.5,"allowedItems": ["string"],"maxItemsInCart": 10.5,"maxAbsoluteValue": 10.5,"absoluteDiscountValue": 10.5}]},"invoiceVersion": "v2","seatingReservationToken": "string","tid": "string","coupons": ["string"],"paymentInfoMethod": "adyen"},"tickets": [{"_id": "string","sellerId": "string","company": "string","email": "string","name": "string","firstname": "string","lastname": "string","street": "string","line2": "string","city": "string","postal": "string","state": "string","country": "string","eventId": "string","rootEventId": "string","transactionId": "string","posId": "string","underShopId": "string","categoryRef": "string","categoryName": "string","ticketTypeId": "string","slotId": "string","cartItemId": "string","triggeredBy": ["string"],"ticketName": "string","currency": "EUR","regularPrice": 10.5,"realPrice": 10.5,"completed": true,"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z","expiresAt": "2030-01-23T23:00:00.123Z","status": "VALID","secret": "string","barcode": "string","seat": "string","seatingInfo": {"_id": "string","_type": 6,"categoryId": "string","statusId": "string","name": "string","seatType": "handicapped","sectionName": "string","groupName": "string","rowName": "string","seatName": "string","gate": "string"},"type": "SINGLE","origin": "yourticket","extraFields": {},"batch": "string","batchCounter": 10.5,"deliveryType": "HARD","readyForDelivery": true,"customMessage": "string","priceCategoryId": "string","entryPermissions": [[]],"customerId": "string","history": [[]],"personalized": true,"excludedEventIds": ["string"],"originTicketId": "string","fulfillmentTypeId": "string","__v": 1}]}
transaction.reservedBySystem
The data of the transaction reserved by system webhook event.
Attributes
transaction
Required
tickets
Required
array<any>
An array of the tickets associated to this transaction
Example
{"transaction": {"_id": "string","sellerId": "string","customerId": "string","eventId": "string","company": "string","name": "string","prename": "string","lastname": "string","street": "string","line2": "string","city": "string","state": "string","country": "string","postal": "string","deliveryAddress": {"street": "string","line2": "string","postal": "string","city": "string","country": "string","state": "string","name": "string"},"tickets": [],"products": [],"additionalItems": [],"currency": "EUR","regularPrice": 10.5,"realPrice": 10.5,"paymentCharge": 10.5,"innerCharge": 10.5,"outerCharge": 10.5,"innerFeeComponents": {"_id": "string","fix": [{"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}],"var": [{"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}]},"outerFeeComponents": {"_id": "string","fix": [{"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}],"var": [{"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}]},"cancellationFee": {"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}},"cancellationInfo": {"cancellableItems": [{"cartItemId": "string","type": "ticket","name": "string","price": 10.5,"taxRate": 10.5,"origin": {"fee": {"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}},"cancellationFee": {"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}},"refundId": "string","cancelledAt": "2030-01-23T23:00:00.123Z"}]},"taxRate": 0.19,"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z","status": "NEW","psp": "string","paymentMethod": "adyen","paymentInfo": {"_id": "string","psp": "string","gateway": "managed","providerType": "vivenu","providerId": "string","method": "string","methodVariant": "string","locale": "string","riskLevel": "string","riskScore": 10.5,"refundId": "string","collectedApplicationFee": 10.5},"paymentStatus": "AWAITING","origin": "yourticket","userId": "string","posId": "string","posInfo": {"_id": "string","sessionId": "string","billingNo": "string","taxId": "string","paymentMethod": "cash","canceledAt": "2030-01-23T23:00:00.123Z","cancellationNo": "2030-01-23T23:00:00.123Z"},"history": [{"_id": "string","date": "2030-01-23T23:00:00.123Z","title": "string","message": "string","type": "YOURTICKET","risk": "NEUTRAL"}],"historyEntries": [{"_id": "string","date": "2030-01-23T23:00:00.123Z","userId": "string","data": {},"type": "created","risk": "NEUTRAL"}],"ticketMailSend": true,"orderMailSend": true,"extraFields": {},"channel": "string","underShop": "string","userAgent": {"_id": "string","ua": "string","browser": {},"device": {},"engine": {},"os": {},"cpu": {}},"ipLookup": {"ip": "string","lookup": {"range": [10.5],"country": "string","region": "string","eu": "string","timezone": "string","city": "string","ll": [10.5],"metro": 10.5,"area": 10.5}},"locationCenter": [10.5],"secret": "string","vouchers": ["string"],"redeemedVouchers": {"totalRedeemedAmount": 10.5,"vouchers": [{"_id": "string","code": "string","redeemedAmount": 10.5}]},"appliedCoupons": [{"_id": "string","code": "string"}],"appliedDiscountGroups": ["string"],"posDiscounts": [{"_id": "string","name": "string","discountType": "fix","value": 10.5}],"preferredLanguage": "de","cancellationReason": "REQUESTED_BY_CUSTOMER","appliedDiscountInfo": {"items": [{"_id": "string","itemId": "string","amount": 10.5,"regularPrice": 10.5,"price": 10.5,"varDiscounts": [{"_id": "string","discountId": "string","category": "coupon","name": "string","type": "fix","value": 10.5,"allowedItems": ["string"]}],"fixDiscounts": [{"_id": "string","discountId": "string","category": "coupon","name": "string","type": "fix","value": 10.5,"allowedItems": ["string"]}]}],"discounts": [{"_id": "string","discountId": "string","category": "coupon","name": "string","type": "fix","value": 10.5,"allowedItems": ["string"],"maxItemsInCart": 10.5,"maxAbsoluteValue": 10.5,"absoluteDiscountValue": 10.5}]},"invoiceVersion": "v2","seatingReservationToken": "string","tid": "string","coupons": ["string"],"paymentInfoMethod": "adyen"},"tickets": [{"_id": "string","sellerId": "string","company": "string","email": "string","name": "string","firstname": "string","lastname": "string","street": "string","line2": "string","city": "string","postal": "string","state": "string","country": "string","eventId": "string","rootEventId": "string","transactionId": "string","posId": "string","underShopId": "string","categoryRef": "string","categoryName": "string","ticketTypeId": "string","slotId": "string","cartItemId": "string","triggeredBy": ["string"],"ticketName": "string","currency": "EUR","regularPrice": 10.5,"realPrice": 10.5,"completed": true,"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z","expiresAt": "2030-01-23T23:00:00.123Z","status": "VALID","secret": "string","barcode": "string","seat": "string","seatingInfo": {"_id": "string","_type": 6,"categoryId": "string","statusId": "string","name": "string","seatType": "handicapped","sectionName": "string","groupName": "string","rowName": "string","seatName": "string","gate": "string"},"type": "SINGLE","origin": "yourticket","extraFields": {},"batch": "string","batchCounter": 10.5,"deliveryType": "HARD","readyForDelivery": true,"customMessage": "string","priceCategoryId": "string","entryPermissions": [[]],"customerId": "string","history": [[]],"personalized": true,"excludedEventIds": ["string"],"originTicketId": "string","fulfillmentTypeId": "string","__v": 1}]}
transaction.canceled
The data of the transaction canceled webhook event.
Attributes
transaction
Required
tickets
Required
array<any>
An array of the tickets associated to this transaction
Example
{"transaction": {"_id": "string","sellerId": "string","customerId": "string","eventId": "string","company": "string","name": "string","prename": "string","lastname": "string","street": "string","line2": "string","city": "string","state": "string","country": "string","postal": "string","deliveryAddress": {"street": "string","line2": "string","postal": "string","city": "string","country": "string","state": "string","name": "string"},"tickets": [],"products": [],"additionalItems": [],"currency": "EUR","regularPrice": 10.5,"realPrice": 10.5,"paymentCharge": 10.5,"innerCharge": 10.5,"outerCharge": 10.5,"innerFeeComponents": {"_id": "string","fix": [{"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}],"var": [{"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}]},"outerFeeComponents": {"_id": "string","fix": [{"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}],"var": [{"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}]},"cancellationFee": {"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}},"cancellationInfo": {"cancellableItems": [{"cartItemId": "string","type": "ticket","name": "string","price": 10.5,"taxRate": 10.5,"origin": {"fee": {"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}},"cancellationFee": {"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}},"refundId": "string","cancelledAt": "2030-01-23T23:00:00.123Z"}]},"taxRate": 0.19,"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z","status": "NEW","psp": "string","paymentMethod": "adyen","paymentInfo": {"_id": "string","psp": "string","gateway": "managed","providerType": "vivenu","providerId": "string","method": "string","methodVariant": "string","locale": "string","riskLevel": "string","riskScore": 10.5,"refundId": "string","collectedApplicationFee": 10.5},"paymentStatus": "AWAITING","origin": "yourticket","userId": "string","posId": "string","posInfo": {"_id": "string","sessionId": "string","billingNo": "string","taxId": "string","paymentMethod": "cash","canceledAt": "2030-01-23T23:00:00.123Z","cancellationNo": "2030-01-23T23:00:00.123Z"},"history": [{"_id": "string","date": "2030-01-23T23:00:00.123Z","title": "string","message": "string","type": "YOURTICKET","risk": "NEUTRAL"}],"historyEntries": [{"_id": "string","date": "2030-01-23T23:00:00.123Z","userId": "string","data": {},"type": "created","risk": "NEUTRAL"}],"ticketMailSend": true,"orderMailSend": true,"extraFields": {},"channel": "string","underShop": "string","userAgent": {"_id": "string","ua": "string","browser": {},"device": {},"engine": {},"os": {},"cpu": {}},"ipLookup": {"ip": "string","lookup": {"range": [10.5],"country": "string","region": "string","eu": "string","timezone": "string","city": "string","ll": [10.5],"metro": 10.5,"area": 10.5}},"locationCenter": [10.5],"secret": "string","vouchers": ["string"],"redeemedVouchers": {"totalRedeemedAmount": 10.5,"vouchers": [{"_id": "string","code": "string","redeemedAmount": 10.5}]},"appliedCoupons": [{"_id": "string","code": "string"}],"appliedDiscountGroups": ["string"],"posDiscounts": [{"_id": "string","name": "string","discountType": "fix","value": 10.5}],"preferredLanguage": "de","cancellationReason": "REQUESTED_BY_CUSTOMER","appliedDiscountInfo": {"items": [{"_id": "string","itemId": "string","amount": 10.5,"regularPrice": 10.5,"price": 10.5,"varDiscounts": [{"_id": "string","discountId": "string","category": "coupon","name": "string","type": "fix","value": 10.5,"allowedItems": ["string"]}],"fixDiscounts": [{"_id": "string","discountId": "string","category": "coupon","name": "string","type": "fix","value": 10.5,"allowedItems": ["string"]}]}],"discounts": [{"_id": "string","discountId": "string","category": "coupon","name": "string","type": "fix","value": 10.5,"allowedItems": ["string"],"maxItemsInCart": 10.5,"maxAbsoluteValue": 10.5,"absoluteDiscountValue": 10.5}]},"invoiceVersion": "v2","seatingReservationToken": "string","tid": "string","coupons": ["string"],"paymentInfoMethod": "adyen"},"tickets": [{"_id": "string","sellerId": "string","company": "string","email": "string","name": "string","firstname": "string","lastname": "string","street": "string","line2": "string","city": "string","postal": "string","state": "string","country": "string","eventId": "string","rootEventId": "string","transactionId": "string","posId": "string","underShopId": "string","categoryRef": "string","categoryName": "string","ticketTypeId": "string","slotId": "string","cartItemId": "string","triggeredBy": ["string"],"ticketName": "string","currency": "EUR","regularPrice": 10.5,"realPrice": 10.5,"completed": true,"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z","expiresAt": "2030-01-23T23:00:00.123Z","status": "VALID","secret": "string","barcode": "string","seat": "string","seatingInfo": {"_id": "string","_type": 6,"categoryId": "string","statusId": "string","name": "string","seatType": "handicapped","sectionName": "string","groupName": "string","rowName": "string","seatName": "string","gate": "string"},"type": "SINGLE","origin": "yourticket","extraFields": {},"batch": "string","batchCounter": 10.5,"deliveryType": "HARD","readyForDelivery": true,"customMessage": "string","priceCategoryId": "string","entryPermissions": [[]],"customerId": "string","history": [[]],"personalized": true,"excludedEventIds": ["string"],"originTicketId": "string","fulfillmentTypeId": "string","__v": 1}]}
Example
{"checkout": {"_id": "string","secret": "string","status": "NEW","type": "transaction","company": "string","firstname": "string","lastname": "string","name": "string","phone": "string","customerId": "string","address": {"street": "string","line2": "string","postal": "string","city": "string","country": "string","state": "string"},"deliveryAddress": {"street": "string","line2": "string","postal": "string","city": "string","country": "string","state": "string","name": "string"},"sellerId": "string","items": [{"_id": "string","eventId": "string","shopId": "string","channelId": "string","redeemedVouchers": {"totalRedeemedAmount": 10.5,"vouchers": [{"_id": "string","code": "string","redeemedAmount": 10.5}]},"appliedCoupons": [{"_id": "string","code": "string"}],"appliedDiscountInfo": {"items": [{"_id": "string","itemId": "string","amount": 10.5,"regularPrice": 10.5,"price": 10.5,"varDiscounts": [{"_id": "string","discountId": "string","category": "coupon","name": "string","type": "fix","value": 10.5,"allowedItems": ["string"]}],"fixDiscounts": [{"_id": "string","discountId": "string","category": "coupon","name": "string","type": "fix","value": 10.5,"allowedItems": ["string"]}]}],"discounts": [{"_id": "string","discountId": "string","category": "coupon","name": "string","type": "fix","value": 10.5,"allowedItems": ["string"],"maxItemsInCart": 10.5,"maxAbsoluteValue": 10.5,"absoluteDiscountValue": 10.5}]},"regularPrice": 10.5,"realPrice": 10.5,"innerFeeComponents": {"_id": "string","fix": [{"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}],"var": [{"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}]},"innerCharge": 10.5,"outerFeeComponents": {"_id": "string","fix": [{"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}],"var": [{"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}]},"outerCharge": 10.5,"tickets": [{"type": "ticket","_id": "string","name": "string","amount": 1,"netPrice": 10.5,"price": 10.5,"taxRate": 10.5,"triggeredBy": "string","bundleInfo": {"bundleId": "string","componentId": "string","optionId": "string"},"ticketTypeId": "string","categoryRef": "string","seatingInfo": {"_id": "string","_type": 6,"categoryId": "string","statusId": "string","name": "string","seatType": "handicapped","sectionName": "string","groupName": "string","rowName": "string","seatName": "string","gate": "string"},"asHardTicket": true,"triggeredAutomations": true,"meta": {}}],"products": [{"type": "product","_id": "string","name": "string","amount": 1,"netPrice": 10.5,"price": 10.5,"taxRate": 10.5,"triggeredBy": "string","bundleInfo": {"bundleId": "string","componentId": "string","optionId": "string"},"productVariantId": "string","isFulfillable": true}],"additionalItems": [],"seatingReservationToken": "string","subscriptionId": "string"}],"realPrice": 10.5,"currency": "EUR","redeemedVouchers": {"totalRedeemedAmount": 10.5,"vouchers": [{"_id": "string","code": "string","redeemedAmount": 10.5}]},"preferredLanguage": "de","origin": "yourticket","channel": "online","salesChannelId": "string","posId": "string","userId": "string","extraFields": {},"expiresAt": "2030-01-23T23:00:00.123Z","createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z"}}
Example
{"checkout": {"_id": "string","secret": "string","status": "NEW","type": "transaction","company": "string","firstname": "string","lastname": "string","name": "string","phone": "string","customerId": "string","address": {"street": "string","line2": "string","postal": "string","city": "string","country": "string","state": "string"},"deliveryAddress": {"street": "string","line2": "string","postal": "string","city": "string","country": "string","state": "string","name": "string"},"sellerId": "string","items": [{"_id": "string","eventId": "string","shopId": "string","channelId": "string","redeemedVouchers": {"totalRedeemedAmount": 10.5,"vouchers": [{"_id": "string","code": "string","redeemedAmount": 10.5}]},"appliedCoupons": [{"_id": "string","code": "string"}],"appliedDiscountInfo": {"items": [{"_id": "string","itemId": "string","amount": 10.5,"regularPrice": 10.5,"price": 10.5,"varDiscounts": [{"_id": "string","discountId": "string","category": "coupon","name": "string","type": "fix","value": 10.5,"allowedItems": ["string"]}],"fixDiscounts": [{"_id": "string","discountId": "string","category": "coupon","name": "string","type": "fix","value": 10.5,"allowedItems": ["string"]}]}],"discounts": [{"_id": "string","discountId": "string","category": "coupon","name": "string","type": "fix","value": 10.5,"allowedItems": ["string"],"maxItemsInCart": 10.5,"maxAbsoluteValue": 10.5,"absoluteDiscountValue": 10.5}]},"regularPrice": 10.5,"realPrice": 10.5,"innerFeeComponents": {"_id": "string","fix": [{"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}],"var": [{"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}]},"innerCharge": 10.5,"outerFeeComponents": {"_id": "string","fix": [{"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}],"var": [{"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}]},"outerCharge": 10.5,"tickets": [{"type": "ticket","_id": "string","name": "string","amount": 1,"netPrice": 10.5,"price": 10.5,"taxRate": 10.5,"triggeredBy": "string","bundleInfo": {"bundleId": "string","componentId": "string","optionId": "string"},"ticketTypeId": "string","categoryRef": "string","seatingInfo": {"_id": "string","_type": 6,"categoryId": "string","statusId": "string","name": "string","seatType": "handicapped","sectionName": "string","groupName": "string","rowName": "string","seatName": "string","gate": "string"},"asHardTicket": true,"triggeredAutomations": true,"meta": {}}],"products": [{"type": "product","_id": "string","name": "string","amount": 1,"netPrice": 10.5,"price": 10.5,"taxRate": 10.5,"triggeredBy": "string","bundleInfo": {"bundleId": "string","componentId": "string","optionId": "string"},"productVariantId": "string","isFulfillable": true}],"additionalItems": [],"seatingReservationToken": "string","subscriptionId": "string"}],"realPrice": 10.5,"currency": "EUR","redeemedVouchers": {"totalRedeemedAmount": 10.5,"vouchers": [{"_id": "string","code": "string","redeemedAmount": 10.5}]},"preferredLanguage": "de","origin": "yourticket","channel": "online","salesChannelId": "string","posId": "string","userId": "string","extraFields": {},"expiresAt": "2030-01-23T23:00:00.123Z","createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z"}}
checkout.detailsSubmitted
The data of the checkout details submitted webhook event.
Attributes
checkout
Required
Example
{"checkout": {"_id": "string","secret": "string","status": "NEW","type": "transaction","company": "string","firstname": "string","lastname": "string","name": "string","phone": "string","customerId": "string","address": {"street": "string","line2": "string","postal": "string","city": "string","country": "string","state": "string"},"deliveryAddress": {"street": "string","line2": "string","postal": "string","city": "string","country": "string","state": "string","name": "string"},"sellerId": "string","items": [{"_id": "string","eventId": "string","shopId": "string","channelId": "string","redeemedVouchers": {"totalRedeemedAmount": 10.5,"vouchers": [{"_id": "string","code": "string","redeemedAmount": 10.5}]},"appliedCoupons": [{"_id": "string","code": "string"}],"appliedDiscountInfo": {"items": [{"_id": "string","itemId": "string","amount": 10.5,"regularPrice": 10.5,"price": 10.5,"varDiscounts": [{"_id": "string","discountId": "string","category": "coupon","name": "string","type": "fix","value": 10.5,"allowedItems": ["string"]}],"fixDiscounts": [{"_id": "string","discountId": "string","category": "coupon","name": "string","type": "fix","value": 10.5,"allowedItems": ["string"]}]}],"discounts": [{"_id": "string","discountId": "string","category": "coupon","name": "string","type": "fix","value": 10.5,"allowedItems": ["string"],"maxItemsInCart": 10.5,"maxAbsoluteValue": 10.5,"absoluteDiscountValue": 10.5}]},"regularPrice": 10.5,"realPrice": 10.5,"innerFeeComponents": {"_id": "string","fix": [{"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}],"var": [{"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}]},"innerCharge": 10.5,"outerFeeComponents": {"_id": "string","fix": [{"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}],"var": [{"_id": "string","amount": 10.5,"value": 10.5,"total": 10.5,"type": "onTicket","name": "string","exposed": true,"scheme": {"schemeId": "string","feeId": "string"}}]},"outerCharge": 10.5,"tickets": [{"type": "ticket","_id": "string","name": "string","amount": 1,"netPrice": 10.5,"price": 10.5,"taxRate": 10.5,"triggeredBy": "string","bundleInfo": {"bundleId": "string","componentId": "string","optionId": "string"},"ticketTypeId": "string","categoryRef": "string","seatingInfo": {"_id": "string","_type": 6,"categoryId": "string","statusId": "string","name": "string","seatType": "handicapped","sectionName": "string","groupName": "string","rowName": "string","seatName": "string","gate": "string"},"asHardTicket": true,"triggeredAutomations": true,"meta": {}}],"products": [{"type": "product","_id": "string","name": "string","amount": 1,"netPrice": 10.5,"price": 10.5,"taxRate": 10.5,"triggeredBy": "string","bundleInfo": {"bundleId": "string","componentId": "string","optionId": "string"},"productVariantId": "string","isFulfillable": true}],"additionalItems": [],"seatingReservationToken": "string","subscriptionId": "string"}],"realPrice": 10.5,"currency": "EUR","redeemedVouchers": {"totalRedeemedAmount": 10.5,"vouchers": [{"_id": "string","code": "string","redeemedAmount": 10.5}]},"preferredLanguage": "de","origin": "yourticket","channel": "online","salesChannelId": "string","posId": "string","userId": "string","extraFields": {},"expiresAt": "2030-01-23T23:00:00.123Z","createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z"}}
Example
{"ticket": {"_id": "string","sellerId": "string","company": "string","email": "string","name": "string","firstname": "string","lastname": "string","street": "string","line2": "string","city": "string","postal": "string","state": "string","country": "string","eventId": "string","rootEventId": "string","transactionId": "string","posId": "string","underShopId": "string","categoryRef": "string","categoryName": "string","ticketTypeId": "string","slotId": "string","cartItemId": "string","triggeredBy": ["string"],"ticketName": "string","currency": "EUR","regularPrice": 10.5,"realPrice": 10.5,"completed": true,"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z","expiresAt": "2030-01-23T23:00:00.123Z","status": "VALID","secret": "string","barcode": "string","seat": "string","seatingInfo": {"_id": "string","_type": 6,"categoryId": "string","statusId": "string","name": "string","seatType": "handicapped","sectionName": "string","groupName": "string","rowName": "string","seatName": "string","gate": "string"},"type": "SINGLE","origin": "yourticket","extraFields": {},"batch": "string","batchCounter": 10.5,"deliveryType": "HARD","readyForDelivery": true,"customMessage": "string","priceCategoryId": "string","entryPermissions": [[]],"customerId": "string","history": [[]],"personalized": true,"excludedEventIds": ["string"],"originTicketId": "string","fulfillmentTypeId": "string","__v": 1}}
Example
{"ticket": {"_id": "string","sellerId": "string","company": "string","email": "string","name": "string","firstname": "string","lastname": "string","street": "string","line2": "string","city": "string","postal": "string","state": "string","country": "string","eventId": "string","rootEventId": "string","transactionId": "string","posId": "string","underShopId": "string","categoryRef": "string","categoryName": "string","ticketTypeId": "string","slotId": "string","cartItemId": "string","triggeredBy": ["string"],"ticketName": "string","currency": "EUR","regularPrice": 10.5,"realPrice": 10.5,"completed": true,"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z","expiresAt": "2030-01-23T23:00:00.123Z","status": "VALID","secret": "string","barcode": "string","seat": "string","seatingInfo": {"_id": "string","_type": 6,"categoryId": "string","statusId": "string","name": "string","seatType": "handicapped","sectionName": "string","groupName": "string","rowName": "string","seatName": "string","gate": "string"},"type": "SINGLE","origin": "yourticket","extraFields": {},"batch": "string","batchCounter": 10.5,"deliveryType": "HARD","readyForDelivery": true,"customMessage": "string","priceCategoryId": "string","entryPermissions": [[]],"customerId": "string","history": [[]],"personalized": true,"excludedEventIds": ["string"],"originTicketId": "string","fulfillmentTypeId": "string","__v": 1}}
purchaseIntent.created
The data of the purchase intent created webhook event.
Attributes
purchaseIntent
Required
Example
{"purchaseIntent": {"_id": "string","status": "new","approvalStatus": "awaiting","rejectionReason": "string","company": "string","firstname": "string","lastname": "string","name": "string","customerId": "string","address": {"street": "string","line2": "string","postal": "string","city": "string","country": "string","state": "string"},"deliveryAddress": {"street": "string","line2": "string","postal": "string","city": "string","country": "string","state": "string","name": "string"},"sellerId": "string","eventId": "string","shopId": "string","strategyId": "string","vouchers": ["string"],"appliedCoupons": [[]],"regularPrice": 10.5,"realPrice": 10.5,"currency": "EUR","innerFeeComponents": [],"innerCharge": 10.5,"outerFeeComponents": [],"outerCharge": 10.5,"tickets": [{"type": "ticket","_id": "string","name": "string","amount": 1,"netPrice": 10.5,"price": 10.5,"taxRate": 10.5,"triggeredBy": "string","bundleInfo": {"bundleId": "string","componentId": "string","optionId": "string"},"ticketTypeId": "string","categoryRef": "string","seatingInfo": {"_id": "string","_type": 6,"categoryId": "string","statusId": "string","name": "string","seatType": "handicapped","sectionName": "string","groupName": "string","rowName": "string","seatName": "string","gate": "string"},"asHardTicket": true,"triggeredAutomations": true,"meta": {}}],"products": [{"type": "product","_id": "string","name": "string","amount": 1,"netPrice": 10.5,"price": 10.5,"taxRate": 10.5,"triggeredBy": "string","bundleInfo": {"bundleId": "string","componentId": "string","optionId": "string"},"productVariantId": "string","isFulfillable": true}],"additionalItems": [],"extraFields": {},"expiresAt": "2030-01-23T23:00:00.123Z","secret": "string","transactionId": "string","outcome": {"checkoutId": "string"},"restrictedCompletion": ["POS"],"cancellationStrategy": "cancellationAllowed","seatingReservationToken": "string","salesChannelId": "string","meta": {},"history": [],"deposit": {"amount": 10.5,"paymentId": "string","balanceTransactionId": "string"},"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z","__v": 1}}
purchaseIntent.updated
The data of the purchase intent updated webhook event.
Attributes
purchaseIntent
Required
Example
{"purchaseIntent": {"_id": "string","status": "new","approvalStatus": "awaiting","rejectionReason": "string","company": "string","firstname": "string","lastname": "string","name": "string","customerId": "string","address": {"street": "string","line2": "string","postal": "string","city": "string","country": "string","state": "string"},"deliveryAddress": {"street": "string","line2": "string","postal": "string","city": "string","country": "string","state": "string","name": "string"},"sellerId": "string","eventId": "string","shopId": "string","strategyId": "string","vouchers": ["string"],"appliedCoupons": [[]],"regularPrice": 10.5,"realPrice": 10.5,"currency": "EUR","innerFeeComponents": [],"innerCharge": 10.5,"outerFeeComponents": [],"outerCharge": 10.5,"tickets": [{"type": "ticket","_id": "string","name": "string","amount": 1,"netPrice": 10.5,"price": 10.5,"taxRate": 10.5,"triggeredBy": "string","bundleInfo": {"bundleId": "string","componentId": "string","optionId": "string"},"ticketTypeId": "string","categoryRef": "string","seatingInfo": {"_id": "string","_type": 6,"categoryId": "string","statusId": "string","name": "string","seatType": "handicapped","sectionName": "string","groupName": "string","rowName": "string","seatName": "string","gate": "string"},"asHardTicket": true,"triggeredAutomations": true,"meta": {}}],"products": [{"type": "product","_id": "string","name": "string","amount": 1,"netPrice": 10.5,"price": 10.5,"taxRate": 10.5,"triggeredBy": "string","bundleInfo": {"bundleId": "string","componentId": "string","optionId": "string"},"productVariantId": "string","isFulfillable": true}],"additionalItems": [],"extraFields": {},"expiresAt": "2030-01-23T23:00:00.123Z","secret": "string","transactionId": "string","outcome": {"checkoutId": "string"},"restrictedCompletion": ["POS"],"cancellationStrategy": "cancellationAllowed","seatingReservationToken": "string","salesChannelId": "string","meta": {},"history": [],"deposit": {"amount": 10.5,"paymentId": "string","balanceTransactionId": "string"},"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z","__v": 1}}
purchaseIntent.completed
The data of the purchase intent completed webhook event.
Attributes
purchaseIntent
Required
Example
{"purchaseIntent": {"_id": "string","status": "new","approvalStatus": "awaiting","rejectionReason": "string","company": "string","firstname": "string","lastname": "string","name": "string","customerId": "string","address": {"street": "string","line2": "string","postal": "string","city": "string","country": "string","state": "string"},"deliveryAddress": {"street": "string","line2": "string","postal": "string","city": "string","country": "string","state": "string","name": "string"},"sellerId": "string","eventId": "string","shopId": "string","strategyId": "string","vouchers": ["string"],"appliedCoupons": [[]],"regularPrice": 10.5,"realPrice": 10.5,"currency": "EUR","innerFeeComponents": [],"innerCharge": 10.5,"outerFeeComponents": [],"outerCharge": 10.5,"tickets": [{"type": "ticket","_id": "string","name": "string","amount": 1,"netPrice": 10.5,"price": 10.5,"taxRate": 10.5,"triggeredBy": "string","bundleInfo": {"bundleId": "string","componentId": "string","optionId": "string"},"ticketTypeId": "string","categoryRef": "string","seatingInfo": {"_id": "string","_type": 6,"categoryId": "string","statusId": "string","name": "string","seatType": "handicapped","sectionName": "string","groupName": "string","rowName": "string","seatName": "string","gate": "string"},"asHardTicket": true,"triggeredAutomations": true,"meta": {}}],"products": [{"type": "product","_id": "string","name": "string","amount": 1,"netPrice": 10.5,"price": 10.5,"taxRate": 10.5,"triggeredBy": "string","bundleInfo": {"bundleId": "string","componentId": "string","optionId": "string"},"productVariantId": "string","isFulfillable": true}],"additionalItems": [],"extraFields": {},"expiresAt": "2030-01-23T23:00:00.123Z","secret": "string","transactionId": "string","outcome": {"checkoutId": "string"},"restrictedCompletion": ["POS"],"cancellationStrategy": "cancellationAllowed","seatingReservationToken": "string","salesChannelId": "string","meta": {},"history": [],"deposit": {"amount": 10.5,"paymentId": "string","balanceTransactionId": "string"},"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z","__v": 1}}
purchaseIntent.approved
The data of the purchase intent approved webhook event.
Attributes
purchaseIntent
Required
Example
{"purchaseIntent": {"_id": "string","status": "new","approvalStatus": "awaiting","rejectionReason": "string","company": "string","firstname": "string","lastname": "string","name": "string","customerId": "string","address": {"street": "string","line2": "string","postal": "string","city": "string","country": "string","state": "string"},"deliveryAddress": {"street": "string","line2": "string","postal": "string","city": "string","country": "string","state": "string","name": "string"},"sellerId": "string","eventId": "string","shopId": "string","strategyId": "string","vouchers": ["string"],"appliedCoupons": [[]],"regularPrice": 10.5,"realPrice": 10.5,"currency": "EUR","innerFeeComponents": [],"innerCharge": 10.5,"outerFeeComponents": [],"outerCharge": 10.5,"tickets": [{"type": "ticket","_id": "string","name": "string","amount": 1,"netPrice": 10.5,"price": 10.5,"taxRate": 10.5,"triggeredBy": "string","bundleInfo": {"bundleId": "string","componentId": "string","optionId": "string"},"ticketTypeId": "string","categoryRef": "string","seatingInfo": {"_id": "string","_type": 6,"categoryId": "string","statusId": "string","name": "string","seatType": "handicapped","sectionName": "string","groupName": "string","rowName": "string","seatName": "string","gate": "string"},"asHardTicket": true,"triggeredAutomations": true,"meta": {}}],"products": [{"type": "product","_id": "string","name": "string","amount": 1,"netPrice": 10.5,"price": 10.5,"taxRate": 10.5,"triggeredBy": "string","bundleInfo": {"bundleId": "string","componentId": "string","optionId": "string"},"productVariantId": "string","isFulfillable": true}],"additionalItems": [],"extraFields": {},"expiresAt": "2030-01-23T23:00:00.123Z","secret": "string","transactionId": "string","outcome": {"checkoutId": "string"},"restrictedCompletion": ["POS"],"cancellationStrategy": "cancellationAllowed","seatingReservationToken": "string","salesChannelId": "string","meta": {},"history": [],"deposit": {"amount": 10.5,"paymentId": "string","balanceTransactionId": "string"},"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z","__v": 1}}
purchaseIntent.rejected
The data of the purchase intent rejected webhook event.
Attributes
purchaseIntent
Required
Example
{"purchaseIntent": {"_id": "string","status": "new","approvalStatus": "awaiting","rejectionReason": "string","company": "string","firstname": "string","lastname": "string","name": "string","customerId": "string","address": {"street": "string","line2": "string","postal": "string","city": "string","country": "string","state": "string"},"deliveryAddress": {"street": "string","line2": "string","postal": "string","city": "string","country": "string","state": "string","name": "string"},"sellerId": "string","eventId": "string","shopId": "string","strategyId": "string","vouchers": ["string"],"appliedCoupons": [[]],"regularPrice": 10.5,"realPrice": 10.5,"currency": "EUR","innerFeeComponents": [],"innerCharge": 10.5,"outerFeeComponents": [],"outerCharge": 10.5,"tickets": [{"type": "ticket","_id": "string","name": "string","amount": 1,"netPrice": 10.5,"price": 10.5,"taxRate": 10.5,"triggeredBy": "string","bundleInfo": {"bundleId": "string","componentId": "string","optionId": "string"},"ticketTypeId": "string","categoryRef": "string","seatingInfo": {"_id": "string","_type": 6,"categoryId": "string","statusId": "string","name": "string","seatType": "handicapped","sectionName": "string","groupName": "string","rowName": "string","seatName": "string","gate": "string"},"asHardTicket": true,"triggeredAutomations": true,"meta": {}}],"products": [{"type": "product","_id": "string","name": "string","amount": 1,"netPrice": 10.5,"price": 10.5,"taxRate": 10.5,"triggeredBy": "string","bundleInfo": {"bundleId": "string","componentId": "string","optionId": "string"},"productVariantId": "string","isFulfillable": true}],"additionalItems": [],"extraFields": {},"expiresAt": "2030-01-23T23:00:00.123Z","secret": "string","transactionId": "string","outcome": {"checkoutId": "string"},"restrictedCompletion": ["POS"],"cancellationStrategy": "cancellationAllowed","seatingReservationToken": "string","salesChannelId": "string","meta": {},"history": [],"deposit": {"amount": 10.5,"paymentId": "string","balanceTransactionId": "string"},"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z","__v": 1}}
purchaseIntent.expired
The data of the purchase intent expired webhook event.
Attributes
purchaseIntent
Required
Example
{"purchaseIntent": {"_id": "string","status": "new","approvalStatus": "awaiting","rejectionReason": "string","company": "string","firstname": "string","lastname": "string","name": "string","customerId": "string","address": {"street": "string","line2": "string","postal": "string","city": "string","country": "string","state": "string"},"deliveryAddress": {"street": "string","line2": "string","postal": "string","city": "string","country": "string","state": "string","name": "string"},"sellerId": "string","eventId": "string","shopId": "string","strategyId": "string","vouchers": ["string"],"appliedCoupons": [[]],"regularPrice": 10.5,"realPrice": 10.5,"currency": "EUR","innerFeeComponents": [],"innerCharge": 10.5,"outerFeeComponents": [],"outerCharge": 10.5,"tickets": [{"type": "ticket","_id": "string","name": "string","amount": 1,"netPrice": 10.5,"price": 10.5,"taxRate": 10.5,"triggeredBy": "string","bundleInfo": {"bundleId": "string","componentId": "string","optionId": "string"},"ticketTypeId": "string","categoryRef": "string","seatingInfo": {"_id": "string","_type": 6,"categoryId": "string","statusId": "string","name": "string","seatType": "handicapped","sectionName": "string","groupName": "string","rowName": "string","seatName": "string","gate": "string"},"asHardTicket": true,"triggeredAutomations": true,"meta": {}}],"products": [{"type": "product","_id": "string","name": "string","amount": 1,"netPrice": 10.5,"price": 10.5,"taxRate": 10.5,"triggeredBy": "string","bundleInfo": {"bundleId": "string","componentId": "string","optionId": "string"},"productVariantId": "string","isFulfillable": true}],"additionalItems": [],"extraFields": {},"expiresAt": "2030-01-23T23:00:00.123Z","secret": "string","transactionId": "string","outcome": {"checkoutId": "string"},"restrictedCompletion": ["POS"],"cancellationStrategy": "cancellationAllowed","seatingReservationToken": "string","salesChannelId": "string","meta": {},"history": [],"deposit": {"amount": 10.5,"paymentId": "string","balanceTransactionId": "string"},"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z","__v": 1}}
purchaseIntent.cancelled
The data of the purchase intent cancelled webhook event.
Attributes
purchaseIntent
Required
Example
{"purchaseIntent": {"_id": "string","status": "new","approvalStatus": "awaiting","rejectionReason": "string","company": "string","firstname": "string","lastname": "string","name": "string","customerId": "string","address": {"street": "string","line2": "string","postal": "string","city": "string","country": "string","state": "string"},"deliveryAddress": {"street": "string","line2": "string","postal": "string","city": "string","country": "string","state": "string","name": "string"},"sellerId": "string","eventId": "string","shopId": "string","strategyId": "string","vouchers": ["string"],"appliedCoupons": [[]],"regularPrice": 10.5,"realPrice": 10.5,"currency": "EUR","innerFeeComponents": [],"innerCharge": 10.5,"outerFeeComponents": [],"outerCharge": 10.5,"tickets": [{"type": "ticket","_id": "string","name": "string","amount": 1,"netPrice": 10.5,"price": 10.5,"taxRate": 10.5,"triggeredBy": "string","bundleInfo": {"bundleId": "string","componentId": "string","optionId": "string"},"ticketTypeId": "string","categoryRef": "string","seatingInfo": {"_id": "string","_type": 6,"categoryId": "string","statusId": "string","name": "string","seatType": "handicapped","sectionName": "string","groupName": "string","rowName": "string","seatName": "string","gate": "string"},"asHardTicket": true,"triggeredAutomations": true,"meta": {}}],"products": [{"type": "product","_id": "string","name": "string","amount": 1,"netPrice": 10.5,"price": 10.5,"taxRate": 10.5,"triggeredBy": "string","bundleInfo": {"bundleId": "string","componentId": "string","optionId": "string"},"productVariantId": "string","isFulfillable": true}],"additionalItems": [],"extraFields": {},"expiresAt": "2030-01-23T23:00:00.123Z","secret": "string","transactionId": "string","outcome": {"checkoutId": "string"},"restrictedCompletion": ["POS"],"cancellationStrategy": "cancellationAllowed","seatingReservationToken": "string","salesChannelId": "string","meta": {},"history": [],"deposit": {"amount": 10.5,"paymentId": "string","balanceTransactionId": "string"},"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z","__v": 1}}
Example
{"customer": {"_id": "string","company": "string","name": "string","prename": "string","lastname": "string","image": "string","number": 10.5,"phone": "string","location": {"street": "string","line2": "string","postal": "string","city": "string","locale": "string","state": "string","center": [10.5],"country": "string"},"transactions": ["string"],"sellerId": "string","notes": "string","extraFields": {},"tags": ["string"],"blocked": true,"verified": true,"_account": {"verificationToken": "string","passwordResetToken": "string","limitations": {"nextVerificationMailRequest": "2030-01-23T23:00:00.123Z"},"loginType": "password"},"meta": {},"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z"}}
Example
{"customer": {"_id": "string","company": "string","name": "string","prename": "string","lastname": "string","image": "string","number": 10.5,"phone": "string","location": {"street": "string","line2": "string","postal": "string","city": "string","locale": "string","state": "string","center": [10.5],"country": "string"},"transactions": ["string"],"sellerId": "string","notes": "string","extraFields": {},"tags": ["string"],"blocked": true,"verified": true,"_account": {"verificationToken": "string","passwordResetToken": "string","limitations": {"nextVerificationMailRequest": "2030-01-23T23:00:00.123Z"},"loginType": "password"},"meta": {},"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z"}}
Example
{"event": {"_id": "string","sellerId": "string","name": "string","slogan": "string","venueId": "string","description": "string","locationName": "string","locationStreet": "string","locationCity": "string","locationPostal": "string","locationCountry": "string","image": "string","ticketFooter": "string","ticketBackground": "string","ticketShopHeader": "string","groups": [{"_id": "string","name": "string","tickets": ["string"]}],"discountGroups": [{"_id": "string","name": "string","rules": [{"_id": "string","group": "string","type": "ticketGroups","min": 10.5,"max": 10.5}],"discountType": "fix","value": 10.5}],"cartAutomationRules": [{"_id": "string","name": "string","triggerType": "hasBeenAdded","triggerTargetGroup": "string","thenType": "autoAdd","thenTargets": [{"_id": "string","thenTargetGroup": "string","thenTargetMin": 10.5,"thenTargetMax": 10.5}]}],"posDiscounts": [{"_id": "string","name": "string","discountType": "fix","value": 10.5}],"categories": [{"_id": "string","name": "string","description": "string","seatingReference": "string","ref": "string","amount": 10.5,"active": true,"recommendedTicket": "string","maxAmountPerOrder": 10.5,"listWithoutSeats": true}],"tickets": [{"_id": "string","name": "string","description": "string","image": "string","color": "string","price": 10.5,"amount": 10.5,"active": true,"posActive": true,"categoryRef": "string","ignoredForStartingPrice": true,"conditionalAvailability": true,"ticketBackground": "string","rules": [{"_id": "string","ticketGroup": "string","min": 10.5,"max": 10.5}],"requiresPersonalization": true,"requiresPersonalizationMode": "ENABLED","requiresExtraFields": true,"requiresExtraFieldsMode": "ENABLED","repersonalizationFee": 10.5,"sortingKey": 10.5,"enableHardTicketOption": true,"forceHardTicketOption": true,"maxAmountPerOrder": 10.5,"minAmountPerOrder": 10.5,"minAmountPerOrderRule": 10.5,"taxRate": 10.5,"styleOptions": {},"priceCategoryId": "string","entryPermissions": [],"ignoreForMaxAmounts": true,"expirationSettings": {},"barcodePrefix": "string","salesStart": {"target": "string","unit": "hours","offset": 1},"salesEnd": {"target": "string","unit": "hours","offset": 1},"transferSettings": {},"scanSettings": {"feedback": "highlight"},"meta": {}}],"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z","start": "2030-01-23T23:00:00.123Z","end": "2030-01-23T23:00:00.123Z","sellStart": "2030-01-23T23:00:00.123Z","sellEnd": "2030-01-23T23:00:00.123Z","maxAmount": 10.5,"maxAmountPerOrder": 10.5,"maxAmountPerCustomer": 10.5,"maxTransactionsPerCustomer": 10.5,"minAmountPerOrder": 1,"showCountdown": true,"hideInListing": true,"visibleAfter": "2030-01-23T23:00:00.123Z","customSettings": {},"extraFields": [{"_id": "string","name": "string","description": "string","required": true,"deleted": true,"type": "text","options": ["string"],"onlyForCertainTicketTypes": true,"allowedTicketTypes": [],"printable": true,"conditions": [{"_id": "string","baseSlug": "string","value": [],"operator": "equals"}]}],"ticketExtraFields": [{"_id": "string","name": "string","description": "string","required": true,"deleted": true,"type": "text","options": ["string"],"onlyForCertainTicketTypes": true,"allowedTicketTypes": [],"printable": true,"conditions": [{"_id": "string","baseSlug": "string","value": [],"operator": "equals"}]}],"accentColor": "#006DCC","pageStyle": "white","showOtherEvents": true,"underShops": [{"_id": "string","name": "string","active": true,"tickets": [{"_id": "string","baseTicket": "string","name": "string","description": "string","price": 10.5,"amount": 10.5,"active": true}],"sellStart": "2030-01-23T23:00:00.123Z","sellEnd": "2030-01-23T23:00:00.123Z","maxAmount": 10.5,"maxAmountPerOrder": 10.5,"minAmountPerOrder": 1,"maxTransactionsPerCustomer": 10.5,"ticketShopHeaderText": "string","customCharges": {},"seatingContingents": ["string"],"availabilityMode": "default","bestAvailableSeatingConfiguration": {"enabled": true,"enforced": true,"allowMassBooking": true},"reservationSettings": {"option": "noReservations"},"accountSettings": {"_id": "string","enforceAccounts": true,"enforceAuthentication": "DISABLED"},"customerTags": [],"allowMassDownload": true,"inventoryStrategy": "independent","extraFields": [{"_id": "string","name": "string","description": "string","required": true,"deleted": true,"type": "text","options": ["string"],"onlyForCertainTicketTypes": true,"allowedTicketTypes": [],"printable": true,"conditions": [{"_id": "string","baseSlug": "string","value": [],"operator": "equals"}]}],"salesChannelGroupSettings": [{"salesChannelGroupId": "string"}],"unlockMode": "none"}],"seating": {"_id": "string","active": true,"eventKey": "string","eventId": "string","seatMapId": "string","revisionId": "string","orphanConfiguration": {"_id": "string","minSeatDistance": 2,"edgeSeatsOrphaning": true},"contingents": ["string"],"availabilityMode": "default","bestAvailableSeatingConfiguration": {"enabled": true,"enforced": true}},"customTextConfig": {"_id": "string","buyTicketsCTA": "string"},"eventType": "SINGLE","childEvents": ["string"],"url": "string","tags": ["string"],"seoSettings": {"_id": "string","tags": ["string"],"noIndex": true,"title": "string","description": "string"},"extraInformation": {"_id": "string","type": "string","category": "string","subCategory": "string"},"customCharges": {"_id": "string","outerChargeVar": 10.5,"innerChargeVar": 10.5,"outerChargeFix": 10.5,"innerChargeFix": 10.5,"posOuterChargeFix": 10.5,"posOuterChargeVar": 10.5,"cartOuterChargeFix": 10.5},"gallery": [{"_id": "string","title": "string","description": "string","copyright": "string","index": 10.5,"image": "string"}],"video": {"youtubeID": "string"},"soldOutFallback": {"_id": "string","soldOutFallbackType": "default","soldOutFallbackLink": "string"},"ticketDesign": {"_id": "string","useCustomDesign": true,"customDesignURL": "string","footerDesignURL": "string","disclaimer": "string","infoColor": "string","showTimeRange": true,"hideDates": true,"hideTimes": true},"checkinInformation": {"_id": "string","checkinStarts": "2030-01-23T23:00:00.123Z"},"tracking": {"facebookPixel": {"active": true,"pixelId": "string"},"tagging": {"enabled": true,"tags": ["string"]}},"hardTicketSettings": {"_id": "string","enabled": true,"fulfillmentType": "self","printingMethod": "preprinted","hardTicketOuterCharge": 10.5,"hardTicketInnerCharge": 10.5,"hardTicketPreviewURL": "string","promotionName": "string","promotionText": "string","requiredDays": 1},"dataRequestSettings": {"requiresPersonalization": false,"requiresExtraFields": false,"repersonalization": false,"posPersonalization": "noPersonalization"},"styleOptions": {"headerStyle": "default","hideLocationMap": false,"hideLocationAddress": false,"categoryAlignment": 0,"showAvailabilityIndicator": false,"availabilityIndicatorThresholds": [0.3,0.7]},"geoCode": {"_id": "string","lat": 10.5,"lng": 10.5},"accountSettings": {"_id": "string","enforceAccounts": true,"enforceAuthentication": "DISABLED"},"reservationSettings": {"option": "noReservations"},"upsellSettings": {"_id": "string","active": true,"productStream": "string","headerImage": "string","crossSells": {"eventIds": ["string"]}},"repetitionSettings": [{"every": 10.5,"unit": "DAY","repeatsOn": ["SUNDAY"],"from": "2030-01-23T23:00:00.123Z","to": "2030-01-23T23:00:00.123Z"}],"rootId": "string","resources": [{"_id": "string","name": "string","capacity": 10.5}],"daySchemes": [{"_id": "string","name": "string","color": "string","usesSlots": true,"slots": [{"_id": "string","start": "string","amount": 1,"offers": {}}],"offers": {}}],"daySchemeId": "string","ticketSettings": {},"accessListMapping": [{"listId": "string","ticketTypeId": "string"}],"deliverySettings": {"wallet": {"enabled": "ENABLED","nfc": "ENABLED","seasonCardShowNextEvent": true},"pdf": {"enabled": "ENABLED"}},"meta": {},"timezone": "string","salesChannelGroupSettings": [{"salesChannelGroupId": "string"}],"timeSlots": [{"_id": "string","startTime": {"hour": 1,"minute": 1},"refs": [{"refType": "category","categoryRef": "string"}]}]}}
Example
{"event": {"_id": "string","sellerId": "string","name": "string","slogan": "string","venueId": "string","description": "string","locationName": "string","locationStreet": "string","locationCity": "string","locationPostal": "string","locationCountry": "string","image": "string","ticketFooter": "string","ticketBackground": "string","ticketShopHeader": "string","groups": [{"_id": "string","name": "string","tickets": ["string"]}],"discountGroups": [{"_id": "string","name": "string","rules": [{"_id": "string","group": "string","type": "ticketGroups","min": 10.5,"max": 10.5}],"discountType": "fix","value": 10.5}],"cartAutomationRules": [{"_id": "string","name": "string","triggerType": "hasBeenAdded","triggerTargetGroup": "string","thenType": "autoAdd","thenTargets": [{"_id": "string","thenTargetGroup": "string","thenTargetMin": 10.5,"thenTargetMax": 10.5}]}],"posDiscounts": [{"_id": "string","name": "string","discountType": "fix","value": 10.5}],"categories": [{"_id": "string","name": "string","description": "string","seatingReference": "string","ref": "string","amount": 10.5,"active": true,"recommendedTicket": "string","maxAmountPerOrder": 10.5,"listWithoutSeats": true}],"tickets": [{"_id": "string","name": "string","description": "string","image": "string","color": "string","price": 10.5,"amount": 10.5,"active": true,"posActive": true,"categoryRef": "string","ignoredForStartingPrice": true,"conditionalAvailability": true,"ticketBackground": "string","rules": [{"_id": "string","ticketGroup": "string","min": 10.5,"max": 10.5}],"requiresPersonalization": true,"requiresPersonalizationMode": "ENABLED","requiresExtraFields": true,"requiresExtraFieldsMode": "ENABLED","repersonalizationFee": 10.5,"sortingKey": 10.5,"enableHardTicketOption": true,"forceHardTicketOption": true,"maxAmountPerOrder": 10.5,"minAmountPerOrder": 10.5,"minAmountPerOrderRule": 10.5,"taxRate": 10.5,"styleOptions": {},"priceCategoryId": "string","entryPermissions": [],"ignoreForMaxAmounts": true,"expirationSettings": {},"barcodePrefix": "string","salesStart": {"target": "string","unit": "hours","offset": 1},"salesEnd": {"target": "string","unit": "hours","offset": 1},"transferSettings": {},"scanSettings": {"feedback": "highlight"},"meta": {}}],"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z","start": "2030-01-23T23:00:00.123Z","end": "2030-01-23T23:00:00.123Z","sellStart": "2030-01-23T23:00:00.123Z","sellEnd": "2030-01-23T23:00:00.123Z","maxAmount": 10.5,"maxAmountPerOrder": 10.5,"maxAmountPerCustomer": 10.5,"maxTransactionsPerCustomer": 10.5,"minAmountPerOrder": 1,"showCountdown": true,"hideInListing": true,"visibleAfter": "2030-01-23T23:00:00.123Z","customSettings": {},"extraFields": [{"_id": "string","name": "string","description": "string","required": true,"deleted": true,"type": "text","options": ["string"],"onlyForCertainTicketTypes": true,"allowedTicketTypes": [],"printable": true,"conditions": [{"_id": "string","baseSlug": "string","value": [],"operator": "equals"}]}],"ticketExtraFields": [{"_id": "string","name": "string","description": "string","required": true,"deleted": true,"type": "text","options": ["string"],"onlyForCertainTicketTypes": true,"allowedTicketTypes": [],"printable": true,"conditions": [{"_id": "string","baseSlug": "string","value": [],"operator": "equals"}]}],"accentColor": "#006DCC","pageStyle": "white","showOtherEvents": true,"underShops": [{"_id": "string","name": "string","active": true,"tickets": [{"_id": "string","baseTicket": "string","name": "string","description": "string","price": 10.5,"amount": 10.5,"active": true}],"sellStart": "2030-01-23T23:00:00.123Z","sellEnd": "2030-01-23T23:00:00.123Z","maxAmount": 10.5,"maxAmountPerOrder": 10.5,"minAmountPerOrder": 1,"maxTransactionsPerCustomer": 10.5,"ticketShopHeaderText": "string","customCharges": {},"seatingContingents": ["string"],"availabilityMode": "default","bestAvailableSeatingConfiguration": {"enabled": true,"enforced": true,"allowMassBooking": true},"reservationSettings": {"option": "noReservations"},"accountSettings": {"_id": "string","enforceAccounts": true,"enforceAuthentication": "DISABLED"},"customerTags": [],"allowMassDownload": true,"inventoryStrategy": "independent","extraFields": [{"_id": "string","name": "string","description": "string","required": true,"deleted": true,"type": "text","options": ["string"],"onlyForCertainTicketTypes": true,"allowedTicketTypes": [],"printable": true,"conditions": [{"_id": "string","baseSlug": "string","value": [],"operator": "equals"}]}],"salesChannelGroupSettings": [{"salesChannelGroupId": "string"}],"unlockMode": "none"}],"seating": {"_id": "string","active": true,"eventKey": "string","eventId": "string","seatMapId": "string","revisionId": "string","orphanConfiguration": {"_id": "string","minSeatDistance": 2,"edgeSeatsOrphaning": true},"contingents": ["string"],"availabilityMode": "default","bestAvailableSeatingConfiguration": {"enabled": true,"enforced": true}},"customTextConfig": {"_id": "string","buyTicketsCTA": "string"},"eventType": "SINGLE","childEvents": ["string"],"url": "string","tags": ["string"],"seoSettings": {"_id": "string","tags": ["string"],"noIndex": true,"title": "string","description": "string"},"extraInformation": {"_id": "string","type": "string","category": "string","subCategory": "string"},"customCharges": {"_id": "string","outerChargeVar": 10.5,"innerChargeVar": 10.5,"outerChargeFix": 10.5,"innerChargeFix": 10.5,"posOuterChargeFix": 10.5,"posOuterChargeVar": 10.5,"cartOuterChargeFix": 10.5},"gallery": [{"_id": "string","title": "string","description": "string","copyright": "string","index": 10.5,"image": "string"}],"video": {"youtubeID": "string"},"soldOutFallback": {"_id": "string","soldOutFallbackType": "default","soldOutFallbackLink": "string"},"ticketDesign": {"_id": "string","useCustomDesign": true,"customDesignURL": "string","footerDesignURL": "string","disclaimer": "string","infoColor": "string","showTimeRange": true,"hideDates": true,"hideTimes": true},"checkinInformation": {"_id": "string","checkinStarts": "2030-01-23T23:00:00.123Z"},"tracking": {"facebookPixel": {"active": true,"pixelId": "string"},"tagging": {"enabled": true,"tags": ["string"]}},"hardTicketSettings": {"_id": "string","enabled": true,"fulfillmentType": "self","printingMethod": "preprinted","hardTicketOuterCharge": 10.5,"hardTicketInnerCharge": 10.5,"hardTicketPreviewURL": "string","promotionName": "string","promotionText": "string","requiredDays": 1},"dataRequestSettings": {"requiresPersonalization": false,"requiresExtraFields": false,"repersonalization": false,"posPersonalization": "noPersonalization"},"styleOptions": {"headerStyle": "default","hideLocationMap": false,"hideLocationAddress": false,"categoryAlignment": 0,"showAvailabilityIndicator": false,"availabilityIndicatorThresholds": [0.3,0.7]},"geoCode": {"_id": "string","lat": 10.5,"lng": 10.5},"accountSettings": {"_id": "string","enforceAccounts": true,"enforceAuthentication": "DISABLED"},"reservationSettings": {"option": "noReservations"},"upsellSettings": {"_id": "string","active": true,"productStream": "string","headerImage": "string","crossSells": {"eventIds": ["string"]}},"repetitionSettings": [{"every": 10.5,"unit": "DAY","repeatsOn": ["SUNDAY"],"from": "2030-01-23T23:00:00.123Z","to": "2030-01-23T23:00:00.123Z"}],"rootId": "string","resources": [{"_id": "string","name": "string","capacity": 10.5}],"daySchemes": [{"_id": "string","name": "string","color": "string","usesSlots": true,"slots": [{"_id": "string","start": "string","amount": 1,"offers": {}}],"offers": {}}],"daySchemeId": "string","ticketSettings": {},"accessListMapping": [{"listId": "string","ticketTypeId": "string"}],"deliverySettings": {"wallet": {"enabled": "ENABLED","nfc": "ENABLED","seasonCardShowNextEvent": true},"pdf": {"enabled": "ENABLED"}},"meta": {},"timezone": "string","salesChannelGroupSettings": [{"salesChannelGroupId": "string"}],"timeSlots": [{"_id": "string","startTime": {"hour": 1,"minute": 1},"refs": [{"refType": "category","categoryRef": "string"}]}]}}
Example
{"event": {"_id": "string","sellerId": "string","name": "string","slogan": "string","venueId": "string","description": "string","locationName": "string","locationStreet": "string","locationCity": "string","locationPostal": "string","locationCountry": "string","image": "string","ticketFooter": "string","ticketBackground": "string","ticketShopHeader": "string","groups": [{"_id": "string","name": "string","tickets": ["string"]}],"discountGroups": [{"_id": "string","name": "string","rules": [{"_id": "string","group": "string","type": "ticketGroups","min": 10.5,"max": 10.5}],"discountType": "fix","value": 10.5}],"cartAutomationRules": [{"_id": "string","name": "string","triggerType": "hasBeenAdded","triggerTargetGroup": "string","thenType": "autoAdd","thenTargets": [{"_id": "string","thenTargetGroup": "string","thenTargetMin": 10.5,"thenTargetMax": 10.5}]}],"posDiscounts": [{"_id": "string","name": "string","discountType": "fix","value": 10.5}],"categories": [{"_id": "string","name": "string","description": "string","seatingReference": "string","ref": "string","amount": 10.5,"active": true,"recommendedTicket": "string","maxAmountPerOrder": 10.5,"listWithoutSeats": true}],"tickets": [{"_id": "string","name": "string","description": "string","image": "string","color": "string","price": 10.5,"amount": 10.5,"active": true,"posActive": true,"categoryRef": "string","ignoredForStartingPrice": true,"conditionalAvailability": true,"ticketBackground": "string","rules": [{"_id": "string","ticketGroup": "string","min": 10.5,"max": 10.5}],"requiresPersonalization": true,"requiresPersonalizationMode": "ENABLED","requiresExtraFields": true,"requiresExtraFieldsMode": "ENABLED","repersonalizationFee": 10.5,"sortingKey": 10.5,"enableHardTicketOption": true,"forceHardTicketOption": true,"maxAmountPerOrder": 10.5,"minAmountPerOrder": 10.5,"minAmountPerOrderRule": 10.5,"taxRate": 10.5,"styleOptions": {},"priceCategoryId": "string","entryPermissions": [],"ignoreForMaxAmounts": true,"expirationSettings": {},"barcodePrefix": "string","salesStart": {"target": "string","unit": "hours","offset": 1},"salesEnd": {"target": "string","unit": "hours","offset": 1},"transferSettings": {},"scanSettings": {"feedback": "highlight"},"meta": {}}],"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z","start": "2030-01-23T23:00:00.123Z","end": "2030-01-23T23:00:00.123Z","sellStart": "2030-01-23T23:00:00.123Z","sellEnd": "2030-01-23T23:00:00.123Z","maxAmount": 10.5,"maxAmountPerOrder": 10.5,"maxAmountPerCustomer": 10.5,"maxTransactionsPerCustomer": 10.5,"minAmountPerOrder": 1,"showCountdown": true,"hideInListing": true,"visibleAfter": "2030-01-23T23:00:00.123Z","customSettings": {},"extraFields": [{"_id": "string","name": "string","description": "string","required": true,"deleted": true,"type": "text","options": ["string"],"onlyForCertainTicketTypes": true,"allowedTicketTypes": [],"printable": true,"conditions": [{"_id": "string","baseSlug": "string","value": [],"operator": "equals"}]}],"ticketExtraFields": [{"_id": "string","name": "string","description": "string","required": true,"deleted": true,"type": "text","options": ["string"],"onlyForCertainTicketTypes": true,"allowedTicketTypes": [],"printable": true,"conditions": [{"_id": "string","baseSlug": "string","value": [],"operator": "equals"}]}],"accentColor": "#006DCC","pageStyle": "white","showOtherEvents": true,"underShops": [{"_id": "string","name": "string","active": true,"tickets": [{"_id": "string","baseTicket": "string","name": "string","description": "string","price": 10.5,"amount": 10.5,"active": true}],"sellStart": "2030-01-23T23:00:00.123Z","sellEnd": "2030-01-23T23:00:00.123Z","maxAmount": 10.5,"maxAmountPerOrder": 10.5,"minAmountPerOrder": 1,"maxTransactionsPerCustomer": 10.5,"ticketShopHeaderText": "string","customCharges": {},"seatingContingents": ["string"],"availabilityMode": "default","bestAvailableSeatingConfiguration": {"enabled": true,"enforced": true,"allowMassBooking": true},"reservationSettings": {"option": "noReservations"},"accountSettings": {"_id": "string","enforceAccounts": true,"enforceAuthentication": "DISABLED"},"customerTags": [],"allowMassDownload": true,"inventoryStrategy": "independent","extraFields": [{"_id": "string","name": "string","description": "string","required": true,"deleted": true,"type": "text","options": ["string"],"onlyForCertainTicketTypes": true,"allowedTicketTypes": [],"printable": true,"conditions": [{"_id": "string","baseSlug": "string","value": [],"operator": "equals"}]}],"salesChannelGroupSettings": [{"salesChannelGroupId": "string"}],"unlockMode": "none"}],"seating": {"_id": "string","active": true,"eventKey": "string","eventId": "string","seatMapId": "string","revisionId": "string","orphanConfiguration": {"_id": "string","minSeatDistance": 2,"edgeSeatsOrphaning": true},"contingents": ["string"],"availabilityMode": "default","bestAvailableSeatingConfiguration": {"enabled": true,"enforced": true}},"customTextConfig": {"_id": "string","buyTicketsCTA": "string"},"eventType": "SINGLE","childEvents": ["string"],"url": "string","tags": ["string"],"seoSettings": {"_id": "string","tags": ["string"],"noIndex": true,"title": "string","description": "string"},"extraInformation": {"_id": "string","type": "string","category": "string","subCategory": "string"},"customCharges": {"_id": "string","outerChargeVar": 10.5,"innerChargeVar": 10.5,"outerChargeFix": 10.5,"innerChargeFix": 10.5,"posOuterChargeFix": 10.5,"posOuterChargeVar": 10.5,"cartOuterChargeFix": 10.5},"gallery": [{"_id": "string","title": "string","description": "string","copyright": "string","index": 10.5,"image": "string"}],"video": {"youtubeID": "string"},"soldOutFallback": {"_id": "string","soldOutFallbackType": "default","soldOutFallbackLink": "string"},"ticketDesign": {"_id": "string","useCustomDesign": true,"customDesignURL": "string","footerDesignURL": "string","disclaimer": "string","infoColor": "string","showTimeRange": true,"hideDates": true,"hideTimes": true},"checkinInformation": {"_id": "string","checkinStarts": "2030-01-23T23:00:00.123Z"},"tracking": {"facebookPixel": {"active": true,"pixelId": "string"},"tagging": {"enabled": true,"tags": ["string"]}},"hardTicketSettings": {"_id": "string","enabled": true,"fulfillmentType": "self","printingMethod": "preprinted","hardTicketOuterCharge": 10.5,"hardTicketInnerCharge": 10.5,"hardTicketPreviewURL": "string","promotionName": "string","promotionText": "string","requiredDays": 1},"dataRequestSettings": {"requiresPersonalization": false,"requiresExtraFields": false,"repersonalization": false,"posPersonalization": "noPersonalization"},"styleOptions": {"headerStyle": "default","hideLocationMap": false,"hideLocationAddress": false,"categoryAlignment": 0,"showAvailabilityIndicator": false,"availabilityIndicatorThresholds": [0.3,0.7]},"geoCode": {"_id": "string","lat": 10.5,"lng": 10.5},"accountSettings": {"_id": "string","enforceAccounts": true,"enforceAuthentication": "DISABLED"},"reservationSettings": {"option": "noReservations"},"upsellSettings": {"_id": "string","active": true,"productStream": "string","headerImage": "string","crossSells": {"eventIds": ["string"]}},"repetitionSettings": [{"every": 10.5,"unit": "DAY","repeatsOn": ["SUNDAY"],"from": "2030-01-23T23:00:00.123Z","to": "2030-01-23T23:00:00.123Z"}],"rootId": "string","resources": [{"_id": "string","name": "string","capacity": 10.5}],"daySchemes": [{"_id": "string","name": "string","color": "string","usesSlots": true,"slots": [{"_id": "string","start": "string","amount": 1,"offers": {}}],"offers": {}}],"daySchemeId": "string","ticketSettings": {},"accessListMapping": [{"listId": "string","ticketTypeId": "string"}],"deliverySettings": {"wallet": {"enabled": "ENABLED","nfc": "ENABLED","seasonCardShowNextEvent": true},"pdf": {"enabled": "ENABLED"}},"meta": {},"timezone": "string","salesChannelGroupSettings": [{"salesChannelGroupId": "string"}],"timeSlots": [{"_id": "string","startTime": {"hour": 1,"minute": 1},"refs": [{"refType": "category","categoryRef": "string"}]}]}}
job.started
The data of the job started webhook event.
Attributes
job
Required
The associated job which has been started
One of
Only one of the following types
job._id
Required
string
The ID of the job
job.sellerId
Required
string
The ID of the seller of the job
job.type
Required
string
transformJobOptional Attributes
Collapse allExample
{"job": {"_id": "string","sellerId": "string","title": "string","type": "transformJob","status": "SCHEDULED","runAfter": "2030-01-23T23:00:00.123Z","startedAt": "2030-01-23T23:00:00.123Z","finishedAt": "2030-01-23T23:00:00.123Z","payload": {"resource": "ticketRangeInvalidation","csv": "string","json": "string","params": {"batch": "string","groups": [[1]]}}}}
job.failed
The data of the job failed webhook event.
Attributes
job
Required
The associated job which has been failed
One of
Only one of the following types
job._id
Required
string
The ID of the job
job.sellerId
Required
string
The ID of the seller of the job
job.type
Required
string
transformJobOptional Attributes
Collapse allExample
{"job": {"_id": "string","sellerId": "string","title": "string","type": "transformJob","status": "SCHEDULED","runAfter": "2030-01-23T23:00:00.123Z","startedAt": "2030-01-23T23:00:00.123Z","finishedAt": "2030-01-23T23:00:00.123Z","payload": {"resource": "ticketRangeInvalidation","csv": "string","json": "string","params": {"batch": "string","groups": [[1]]}}}}
job.completed
The data of the job completed webhook event.
Attributes
job
Required
The associated job which has been completed
One of
Only one of the following types
job._id
Required
string
The ID of the job
job.sellerId
Required
string
The ID of the seller of the job
job.type
Required
string
transformJobOptional Attributes
Collapse allExample
{"job": {"_id": "string","sellerId": "string","title": "string","type": "transformJob","status": "SCHEDULED","runAfter": "2030-01-23T23:00:00.123Z","startedAt": "2030-01-23T23:00:00.123Z","finishedAt": "2030-01-23T23:00:00.123Z","payload": {"resource": "ticketRangeInvalidation","csv": "string","json": "string","params": {"batch": "string","groups": [[1]]}}}}
support.assignedToSeller
The data of the support assigned to seller webhook event.
Attributes
support
Required
object
The associated support has been assigned
support._id
Required
string
The ID of the status
support.name
Required
string
The name of the ticket
support.email
Required
string email
The email of the ticket creator
support.status
Required
string
The current status of the support ticket
NEWINPROGRESSRESOLVEDsupport.priority
Required
string
The priority of the support tickt
LOWMEDIUMHIGHsupport.secret
Required
string
The secret of the support ticket
support.lastInteraction
Required
string date-time
An ISO timestamp indicating the last interaction with the ticket
support.createdAt
Required
string date-time
An ISO timestamp indicating when the support ticket was created
support.updatedAt
Required
string date-time
An ISO timestamp indicating when the support ticket was updated
Optional Attributes
Collapse allExample
{"support": {"_id": "string","transactionId": "string","name": "string","firstname": "string","lastname": "string","status": "NEW","priority": "MEDIUM","messages": [{"_id": "string","userId": "string","senderName": "string","message": "string","createdAt": "2030-01-23T23:00:00.123Z"}],"secret": "string","assignee": "string","assignedToSeller": true,"lastInteraction": "2030-01-23T23:00:00.123Z","sellerId": "string","preferredLanguage": "de","createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z"}}
ticketTransfer.created
The data of the ticket transfer created webhook event.
Attributes
ticketTransfer
Required
Example
{"ticketTransfer": {"_id": "string","secret": "string","ticketIds": ["string"],"eventId": "string","groupEventId": "string","sellerId": "string","status": "CREATED","origin": "customer","recipient": {"phone": "string","customerId": "string"},"sender": {},"outcome": {"tickets": [{"ticketId": "string","originTicketId": "string"}]},"history": [{"_id": "string","date": "2030-01-23T23:00:00.123Z","userId": "string","type": "created"}],"expiresAt": "2030-01-23T23:00:00.123Z","createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z"}}
ticketTransfer.rejected
The data of the ticket transfer rejected webhook event.
Attributes
ticketTransfer
Required
Example
{"ticketTransfer": {"_id": "string","secret": "string","ticketIds": ["string"],"eventId": "string","groupEventId": "string","sellerId": "string","status": "CREATED","origin": "customer","recipient": {"phone": "string","customerId": "string"},"sender": {},"outcome": {"tickets": [{"ticketId": "string","originTicketId": "string"}]},"history": [{"_id": "string","date": "2030-01-23T23:00:00.123Z","userId": "string","type": "created"}],"expiresAt": "2030-01-23T23:00:00.123Z","createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z"}}
ticketTransfer.transferred
The data of the ticket transfer transferred webhook event.
Attributes
ticketTransfer
Required
Example
{"ticketTransfer": {"_id": "string","secret": "string","ticketIds": ["string"],"eventId": "string","groupEventId": "string","sellerId": "string","status": "CREATED","origin": "customer","recipient": {"phone": "string","customerId": "string"},"sender": {},"outcome": {"tickets": [{"ticketId": "string","originTicketId": "string"}]},"history": [{"_id": "string","date": "2030-01-23T23:00:00.123Z","userId": "string","type": "created"}],"expiresAt": "2030-01-23T23:00:00.123Z","createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z"}}
ticketTransfer.expired
The data of the ticket transfer expired webhook event.
Attributes
ticketTransfer
Required
Example
{"ticketTransfer": {"_id": "string","secret": "string","ticketIds": ["string"],"eventId": "string","groupEventId": "string","sellerId": "string","status": "CREATED","origin": "customer","recipient": {"phone": "string","customerId": "string"},"sender": {},"outcome": {"tickets": [{"ticketId": "string","originTicketId": "string"}]},"history": [{"_id": "string","date": "2030-01-23T23:00:00.123Z","userId": "string","type": "created"}],"expiresAt": "2030-01-23T23:00:00.123Z","createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z"}}
scan.created
The data of the scan created webhook event.
Attributes
scan
Required
object
The associated scan which has been created
scan.ticketId
Required
string
The ID of the ticket
scan.eventId
Required
string
The ID of the event
scan.barcode
Required
string
The barcode
scan.ticketTypeId
Required
string
The ID of the ticket type
scan.type
Required
string
The scan type
checkincheckoutscan.scanResult
Required
string
The scan result
approveddeclinedOptional Attributes
Collapse allExample
{"scan": {"ticketId": "string","time": "2030-01-23T23:00:00.123Z","eventId": "string","parentEventId": "string","barcode": "string","name": "string","ticketTypeId": "string","ticketName": "string","deviceId": "string","type": "checkin","scanResult": "approved","sellerId": "string"}}
bundle.created
The data of the bundle created webhook event.
Attributes
bundle
Required
object
The associated bundle which has been created
bundle._id
Required
string
The ID of the bundle
bundle.active
Required
boolean
Whether the bundle is active
bundle.name
Required
string
The name of the bundle
bundle.description
Required
string
The description of the bundle
bundle.image
Required
string
The image of the bundle
bundle.components
Required
array
The components of the bundle
bundle.components[].name
Required
string
The ID of the bundle component
bundle.components[].options
Required
array
Options for the bundle component
One of
Only one of the following types
bundle.components[].options[].type
Required
The type of the bundle component option
tickettypeOne of
Only one of the following types
Optional Attributes
Collapse allbundle.components[].minQuantity
Required
number float
Minimum quantity of the bundle component
bundle.components[].maxQuantity
Required
number float
Maximum quantity of the bundle component
Optional Attributes
Collapse allbundle.triggers
Required
array
The triggers of the bundle
Optional Attributes
Collapse allbundle.triggers[].type
Optional
string
bundle.sellerId
Required
string
The ID of the seller of the bundle
bundle.showOnlyTotalPrice
Required
boolean
Whether to show the total only
Optional Attributes
Collapse allExample
{"bundle": {"_id": "string","active": true,"name": "string","description": "string","image": "string","components": [{"_id": "string","name": "string","options": [{"_id": "string","type": [],"price": 10.5,"ticketType": {"ticketTypeId": "string","eventId": "string"}}],"minQuantity": 10.5,"maxQuantity": 10.5,"localization": {}}],"triggers": [{"_id": "string","type": "string","target": {"componentId": "string"}}],"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z","sellerId": "string","showOnlyTotalPrice": true,"localization": {}}}
bundle.updated
The data of the bundle updated webhook event.
Attributes
bundle
Required
object
The associated bundle which has been updated
bundle._id
Required
string
The ID of the bundle
bundle.active
Required
boolean
Whether the bundle is active
bundle.name
Required
string
The name of the bundle
bundle.description
Required
string
The description of the bundle
bundle.image
Required
string
The image of the bundle
bundle.components
Required
array
The components of the bundle
bundle.components[].name
Required
string
The ID of the bundle component
bundle.components[].options
Required
array
Options for the bundle component
One of
Only one of the following types
bundle.components[].options[].type
Required
The type of the bundle component option
tickettypeOne of
Only one of the following types
Optional Attributes
Collapse allbundle.components[].minQuantity
Required
number float
Minimum quantity of the bundle component
bundle.components[].maxQuantity
Required
number float
Maximum quantity of the bundle component
Optional Attributes
Collapse allbundle.triggers
Required
array
The triggers of the bundle
Optional Attributes
Collapse allbundle.triggers[].type
Optional
string
bundle.sellerId
Required
string
The ID of the seller of the bundle
bundle.showOnlyTotalPrice
Required
boolean
Whether to show the total only
Optional Attributes
Collapse allExample
{"bundle": {"_id": "string","active": true,"name": "string","description": "string","image": "string","components": [{"_id": "string","name": "string","options": [{"_id": "string","type": [],"price": 10.5,"ticketType": {"ticketTypeId": "string","eventId": "string"}}],"minQuantity": 10.5,"maxQuantity": 10.5,"localization": {}}],"triggers": [{"_id": "string","type": "string","target": {"componentId": "string"}}],"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z","sellerId": "string","showOnlyTotalPrice": true,"localization": {}}}
product.created
The data of the product created webhook event.
Attributes
product
Required
object
product._id
Required
string
The ID of the product
product.name
Required
string
The name of the product
product.type
Required
string
The type of the product
voucherproductdonationproduct.sellerId
Required
string
The ID of the seller of the product
Optional Attributes
Collapse allExample
{"product": {"_id": "string","name": "string","active": true,"isFulfillable": true,"type": "voucher","image": "string","description": "string","variants": [{"_id": "string","priceType": "fixed","price": 10.5,"priceRange": {"min": 10.5,"max": 10.5},"taxable": true,"taxRate": 10.5,"compareAtPrice": 10.5,"taxServiceTypeId": "string"}],"voucherSettings": {"limitedValidityPeriod": true,"validityConfig": {"amount": 10.5,"type": 10.5,"untilEndOfPeriod": true},"pdfImage": "string","disclaimer": "string","documentTemplateSettings": {"templates": [{"templateId": "string","format": "A4","target": "thermal","type": "ticket"}]}},"sellerId": "string","meta": {},"localization": {},"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z"}}
product.updated
The data of the product updated webhook event.
Attributes
product
Required
object
product._id
Required
string
The ID of the product
product.name
Required
string
The name of the product
product.type
Required
string
The type of the product
voucherproductdonationproduct.sellerId
Required
string
The ID of the seller of the product
Optional Attributes
Collapse allExample
{"product": {"_id": "string","name": "string","active": true,"isFulfillable": true,"type": "voucher","image": "string","description": "string","variants": [{"_id": "string","priceType": "fixed","price": 10.5,"priceRange": {"min": 10.5,"max": 10.5},"taxable": true,"taxRate": 10.5,"compareAtPrice": 10.5,"taxServiceTypeId": "string"}],"voucherSettings": {"limitedValidityPeriod": true,"validityConfig": {"amount": 10.5,"type": 10.5,"untilEndOfPeriod": true},"pdfImage": "string","disclaimer": "string","documentTemplateSettings": {"templates": [{"templateId": "string","format": "A4","target": "thermal","type": "ticket"}]}},"sellerId": "string","meta": {},"localization": {},"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z"}}
product.deleted
The data of the product deleted webhook event.
Attributes
product
Required
object
product._id
Required
string
The ID of the product
product.name
Required
string
The name of the product
product.type
Required
string
The type of the product
voucherproductdonationproduct.sellerId
Required
string
The ID of the seller of the product
Optional Attributes
Collapse allExample
{"product": {"_id": "string","name": "string","active": true,"isFulfillable": true,"type": "voucher","image": "string","description": "string","variants": [{"_id": "string","priceType": "fixed","price": 10.5,"priceRange": {"min": 10.5,"max": 10.5},"taxable": true,"taxRate": 10.5,"compareAtPrice": 10.5,"taxServiceTypeId": "string"}],"voucherSettings": {"limitedValidityPeriod": true,"validityConfig": {"amount": 10.5,"type": 10.5,"untilEndOfPeriod": true},"pdfImage": "string","disclaimer": "string","documentTemplateSettings": {"templates": [{"templateId": "string","format": "A4","target": "thermal","type": "ticket"}]}},"sellerId": "string","meta": {},"localization": {},"createdAt": "2030-01-23T23:00:00.123Z","updatedAt": "2030-01-23T23:00:00.123Z"}}
Verify signature
The signature can be verified by calculating the HMAC of the raw json string with key=webhook.hmacKey, alg=sha256 and comparing it to the x-vivenu-signature header of the request.
Verify Signature
const HMAC_KEY = "4f1f83b5-b4..."
const signature = crypto
.createHmac("sha256", HMAC_KEY)
.update(req.rawPayload).digest("hex")
const requestSignature = req.headers["x-vivenu-signature"]
const isValid = signature.toLowerCase() === requestSignature.toLowerCase()