In this section

Payload of a Webhook

The payload of a webhook is a simple JSON file. Within the JSON file you can access all the given attributes which contain the information that are being handed over from us over to you. The JSON file should be readable for any service that supports JSON-files. To give you an idea what kind of attributes can be found within the payload, we are displaying all the attributes which can be found inside the test data for specific actions down below. Certain attributes may only appear on specific triggers, as they may not exist within the payload.

Order

This is the resulting payload for the OrderCreated & OrderCancelled webhook actions:

{
    "Tickets": [
        {
            "TicketType": {
                "Event": {

                    // Here you find all the event information. 
                    // For example: name, description, banner image etc.
                    "EventInfos": [

                        // Here every language has one object. 
                        // So if you have a german and an english version you will have 2 objects inside this array
                        {
                            "Id": 1,
                            "BannerImagePath": null,
                            "FlyerImagePath": null,
                            "ListingImagePath": null,
                            "EventId": 1,
                            "LanguageId": 1,
                            "Name": "TestEvent_",
                            "OrganizerNameOnTickets": null,
                            "ShortDescription": null,
                            "ImportantNotes": "Important notes",
                            "LongDescription": "Long Description",
                            "Artists": null,
                            "Url": null,
                            "City": "",
                            "Location": null,
                            "Address": "",
                            "ZipCode": "8000",
                            "BannerImage": null,
                            "FlyerImage": null,
                            "ListingImage": null,
                            "OrganizerRemark": "Organizer Remark",
                            "PosRemark": null,
                            "GoogleMapLink": ""
                        }
                    ],

                    // Here you can find all the general attributes of an event
                    "Location": null,
                    "Id": 1,
                    "OrganizerId": 4,
                    "Status": 1,
                    "OpenDoor": "2023-06-15T13:32:55.4967451+02:00",
                    "Start": "2023-06-15T13:32:55.4967447+02:00",
                    "End": "2023-06-22T13:32:55.4967455+02:00",
                    "ZoneMapId": null,
                    "MasterEventId": null,
                    "TenantId": 2,
                    "LocationId": null,
                    "NoVatOnCommission": false,
                    "ShippingFee": 0.0,
                    "SendNotificationByEmail": false,
                    "NotificationEmail": null,
                    "VATNumber": "Tick_123",
                    "SendWarning": false,
                    "SalesRegionId": 1,
                    "EmailTemplate": null,
                    "Latitude": null,
                    "Longitude": null,
                    "ExternalEventCode": null,
                    "ForceEmptySeats": 0,
                    "PreSaleStart": null,
                    "PreSaleEnd": null,
                    "Remarks": null,
                    "CancellationReason": null,
                    "CancellationDate": null
                },

                // Here you find all the ticketType information. 
                // For example: name, description, image url etc.
                "TicketTypeInfos": [

                    // Here every language has one object. 
                    // So if you have a german and an english version you will have 2 objects inside this array
                    {
                        "Id": 1,
                        "AdditionalFileUrl": null,
                        "ImageUrl": null,
                        "TicketTypeId": 1,
                        "Name": "TestTicket",
                        "LanguageId": 1,
                        "Description": "Description",
                        "Image": null,
                        "AdditionalFile": "AdditionalFile",
                        "AlternateImageUrl": null,
                        "CustomText1": "Customtext1",
                        "CustomText2": "Customtext2",
                        "CustomText3": "Customtext3",
                        "CustomText4": "Customtext4",
                        "CustomText1Mandatory": false,
                        "CustomText2Mandatory": false,
                        "Presentation": null,
                        "Deleted": null,
                        "EmailSubject": null,
                        "SenderName": null
                    }
                ],

                // Here you can find all the general attributes of a ticketType
                "Id": 1,
                "EventId": 1,
                "TicketsTotal": 100,
                "Currency": "CHF",
                "Price": 50.00,
                "Start": null,
                "End": null,
                "VatPercentage": 0.00,
                "MaxMemberTickets": 0,
                "BookWithTicketTypeId": null,
                "PreSaleStart": null,
                "PreSaleEnd": null,
                "OpenDoor": null,
                "InvoiceEnd": null,
                "CallCenterEnd": null,
                "SofortEnd": null,
                "PromoCodeIdToPrint": null,
                "TicketTemplate": "newStandardTop",
                "MaxNumberOfTicketsPerOrder": 10,
                "NumberOfTicketsToBasket": 1,
                "FestivalEventIds": null,
                "TicketByEmail": false,
                "IsSoldOut": null,
                "VatInGivenAmount": null,
                "SenderEmail": null,
                "ReplyTo": null,
                "EmailTemplate": null,
                "ExternalTicketCode": null,
                "IsTakingDatesAndTimesFromEvent": false
            },

            // Here you can find all the general attributes of the booked ticket
            "Id": 123,
            "UniqueKey": null,
            "CancelledDate": null,
            "CancelledByUser": null,
            "OrderId": 0,
            "TicketTypeId": 1,
            "Price": 0.0,
            "TicketPrice": 0.0,
            "Currency": null,
            "Email": null,
            "IsCancelled": false,
            "PromotionCode": null,
            "GeneratedPromotionCode": null,
            "TicketTypePrice": null,
            "PosCharge": null,
            "PosChargeVat": null,
            "Vat": null,
            "TicketVatPercentage": null,
            "Remark": null,
            "Company": null,
            "Firstname": null,
            "Lastname": null,
            "CustomValue1": null,
            "CustomValue2": null,
            "CustomValue3": null,
            "CustomValue4": null,
            "OverheadAmount": null,
            "OverheadVatAmount": null,
            "InsuranceAmount": null,
            "Option1": null,
            "Option2": null,
            "Option3": null,
            "Option4": null,
            "Option5": null,
            "Option6": null,
            "Option7": null,
            "Option8": null,
            "Option9": null,
            "Option10": null,
            "Option11": null,
            "Option12": null,
            "Option13": null,
            "Option14": null,
            "Option15": null,
            "Option16": null,
            "Option17": null,
            "Option18": null,
            "Option19": null,
            "Option20": null,
            "Option21": null,
            "Option22": null,
            "Option23": null,
            "Option24": null,
            "BookedDate": "0001-01-01T00:00:00",
            "Salutation": null,
            "Title": null,
            "Function": null,
            "Position": null,
            "BirthDate": null,
            "AdditionalCompany": null,
            "Street": null,
            "PostOffice": null,
            "PostCode": null,
            "City": null,
            "Country": null,
            "Phone": null,
            "PhoneDial": null,
            "Phone2": null,
            "Mobile": null,
            "Fax": null,
            "Url": null,
            "Branch": null,
            "CompanyEmail": null,
            "NewsLetter": null,
            "DbCode": null,
            "TimeOfEntryFrom": null,
            "TimeOfEntryTo": null
        }
    ],

    // Here you can find all the general attributes of the ticket buyer. 
    // In case of purchases "organizer" can also mean buyer
    "Organizer": {
        "OrganizerId": 0,
        "AddressId": null,
        "LoginUserId": null,
        "Username": null,
        "BirthDate": null,
        "OrganizerDisplayName": null,
        "UrlWebsite": null,
        "UrlFacebook": null,
        "UrlTwitter": null,
        "UrlInstagram": null,
        "UrlXing": null,
        "UrlLinkedIn": null,
        "BannerImage": null,
        "LogoImage": null,
        "IsNewsletterDoubleOptInProgress": false,
        "Salutation": "",
        "Title": "",
        "FirstName": "",
        "LastName": "",
        "CompanyName": "",
        "Street": "",
        "PostCode": "",
        "City": "",
        "CountryId": 0,
        "LanguageId": null,
        "Phone": "",
        "Mobile": "",
        "Email": "",
        "IBANCode": null,
        "PaymentName": null,
        "PaymentStreet": null,
        "PaymentCity": null,
        "PaymentPostCode": null,
        "PaymentCountryId": null,
        "PostOfficeBox": "",
        "Address2": "",
        "OrganizerType": null,
        "BankIdentifierCode": null,
        "SalesStaffId": null,
        "SupportStaffId": null,
        "CurrencyId": null,
        "InvoiceCost": null,
        "InvoiceCostVat": null,
        "SupressEmailReminder": null,
        "ModifyBuyerAddress": null,
        "PreventChanges": null,
        "TicketBuyerNewsLetter": null,
        "OrganizerNewsLetter": null,
        "NoVatOnCommission": false,
        "Remarks": null
    },

    // Here you can find all the general attributes of the finished order. 
    // For example: orderId, invoice number etc.
    "Id": 0,
    "InvoiceNumber": 1,
    "DateCreated": "2023-05-31T13:32:55.4967221+02:00",
    "DateModified": "2023-06-01T13:32:55.4967266+02:00",
    "CancelledDate": null,
    "ReferenceNumber": null,
    "IsPaid": true,
    "OrganizerBuyerId": 1,
    "Currency": "CHF",
    "TotalPrice": 10.0,
    "PointOfSaleId": 0,
    "IsCompleted": true,
    "IsCancelled": false,
    "TotalInsuranceAmount": 0.0,
    "Total": 10.0,
    "VatOfAllTickets": null,
    "DeliverPaymentFee": 0.0,
    "DeliverPaymentFeeVat": 0.0,
    "DeliveryMethodId": null,
    "PaymentMethodId": 2,
    "AdditionalText1": null,
    "AdditionalText2": null,
    "AdditionalText3": null,
    "AdditionalText4": null,
    "AdditionalText5": null,
    "PromoCode": null,
    "OrderStatus": 0,
    "Abbreviation": null,
    "Remark": null,
    "PromotionCode": null,
    "DiscountOrderPromotion": 0.0
}

Event

This is the resulting payload for EventAdded, EventUpdated, EventPublished & EventUnpublished webhook actions:

{

    // Here you find all the event information. 
    // For example: name, description, banner image etc.
    "EventInfos": [

        // Here every language has one object. 
        // So if you have a german and an english version you will have 2 objects inside this array
        {
            "Id": 1,
            "BannerImagePath": null,
            "FlyerImagePath": null,
            "ListingImagePath": null,
            "EventId": 1,
            "LanguageId": 1,
            "Name": "TestEvent_",
            "OrganizerNameOnTickets": null,
            "ShortDescription": null,
            "ImportantNotes": "Important notes",
            "LongDescription": "Long Description",
            "Artists": null,
            "Url": null,
            "City": "",
            "Location": null,
            "Address": "",
            "ZipCode": "8000",
            "BannerImage": null,
            "FlyerImage": null,
            "ListingImage": null,
            "OrganizerRemark": "Organizer Remark",
            "PosRemark": null,
            "GoogleMapLink": ""
        }
    ],
    "Location": {
    
        // Here you find all the location information. 
        // For example: name, description, banner image etc.
        "LocationInfos": [

            // Here every language has one object. 
            // So if you have a german and an english version you will have 2 objects inside this array
            {
                "Id": 0,
                "BannerImagePath": null,
                "LogoImagePath": null,
                "LocationId": 0,
                "LanguageId": 0,
                "Name": "Test Location",
                "Description": "Description",
                "Street": null,
                "StreetNumber": null,
                "PostalCode": null,
                "City": "City",
                "Url": null,
                "UrlGoogleMap": null,
                "BannerImage": null,
                "LogoImage": null,
                "RouteDescription": null,
                "OpeningHours": null
            }
        ],

        // Here you can find all the general attributes of a location
        "Id": 0,
        "CountryId": 0,
        "IsActive": false,
        "Latitude": null,
        "Longitude": null,
        "Phone": null,
        "Email": null,
        "StandardLanguageId": 0,
        "OrganizerId": null,
        "DateCreated": "0001-01-01T00:00:00",
        "DateEdited": "0001-01-01T00:00:00"
    },

    // Here you can find all the general attributes of an event
    "Id": 1,
    "OrganizerId": 4,
    "Status": 1,
    "OpenDoor": "2023-06-16T13:06:51.1841972+02:00",
    "Start": "2023-06-16T13:06:51.1841939+02:00",
    "End": "2023-06-23T13:06:51.1841976+02:00",
    "ZoneMapId": null,
    "PostSaleCloseStatus": 1,
    "MasterEventId": null,
    "TenantId": 2,
    "LocationId": null,
    "NoVatOnCommission": false,
    "ShippingFee": 0.0,
    "SendNotificationByEmail": false,
    "NotificationEmail": null,
    "VATNumber": "Tick_123",
    "SendWarning": false,
    "SalesRegionId": 1,
    "EmailTemplate": null,
    "Latitude": null,
    "Longitude": null,
    "ExternalEventCode": null,
    "ForceEmptySeats": 0,
    "PreSaleStart": null,
    "PreSaleEnd": null,
    "Remarks": null,
    "CancellationReason": null,
    "CancellationDate": null
}

TicketType

This is the resulting payload for TicketTypeAdded & TicketTypeUpdated webhook actions:

{

    // Here you find all the ticketType information. 
    // For example: name, description, image url etc.
    "TicketTypeInfos": [

        // Here every language has one object. 
        // So if you have a german and an english version you will have 2 objects inside this array
        {
            "Id": 1,
            "AdditionalFileUrl": null,
            "ImageUrl": null,
            "OriginalImageData": null,
            "CroppedImageData": null,
            "OriginalFileData": null,
            "TicketTypeId": 1,
            "Name": "TestTicket",
            "LanguageId": 1,
            "Description": "Description",
            "Image": null,
            "AdditionalFile": "AdditionalFile",
            "AlternateImageUrl": null,
            "CustomText1": "Customtext1",
            "CustomText2": "Customtext2",
            "CustomText3": "Customtext3",
            "CustomText4": "Customtext4",
            "CustomText1Mandatory": false,
            "CustomText2Mandatory": false,
            "Presentation": null,
            "Deleted": null,
            "EmailSubject": null,
            "SenderName": null
        }
    ],

    // Here you can find all the general attributes of a ticketType
    "Id": 1,
    "EventId": 1,
    "TicketsTotal": 100,
    "Currency": "CHF",
    "Price": 50.00,
    "Start": null,
    "End": null,
    "VatPercentage": 0.00,
    "MaxMemberTickets": 0,
    "BookWithTicketTypeId": null,
    "PreSaleStart": null,
    "PreSaleEnd": null,
    "OpenDoor": null,
    "InvoiceEnd": null,
    "CallCenterEnd": null,
    "SofortEnd": null,
    "PromoCodeIdToPrint": null,
    "TicketTemplate": "newStandardTop",
    "MaxNumberOfTicketsPerOrder": 10,
    "NumberOfTicketsToBasket": 1,
    "FestivalEventIds": null,
    "TicketByEmail": false,
    "IsSoldOut": null,
    "VatInGivenAmount": null,
    "SenderEmail": null,
    "ReplyTo": null,
    "EmailTemplate": null,
    "ExternalTicketCode": null,
    "IsTakingDatesAndTimesFromEvent": false
}

EntryScanned

This is the resulting payload for EntryScanned webhook action:

{

    // Here you can find all the general attributes of the booked ticket
    "Ticket": {
        "Id": 123,
        "UniqueKey": null,
        "CancelledDate": null,
        "CancelledByUser": null,
        "OrderId": 0,
        "TicketTypeId": 0,
        "Price": 0.0,
        "TicketPrice": 0.0,
        "Currency": null,
        "Email": null,
        "IsCancelled": false,
        "PromotionCode": null,
        "GeneratedPromotionCode": null,
        "TicketTypePrice": null,
        "PosCharge": null,
        "PosChargeVat": null,
        "Vat": null,
        "TicketVatPercentage": null,
        "Remark": null,
        "Company": null,
        "Firstname": null,
        "Lastname": null,
        "CustomValue1": null,
        "CustomValue2": null,
        "CustomValue3": null,
        "CustomValue4": null,
        "OverheadAmount": null,
        "OverheadVatAmount": null,
        "InsuranceAmount": null,
        "Option1": null,
        "Option2": null,
        "Option3": null,
        "Option4": null,
        "Option5": null,
        "Option6": null,
        "Option7": null,
        "Option8": null,
        "Option9": null,
        "Option10": null,
        "Option11": null,
        "Option12": null,
        "Option13": null,
        "Option14": null,
        "Option15": null,
        "Option16": null,
        "Option17": null,
        "Option18": null,
        "Option19": null,
        "Option20": null,
        "Option21": null,
        "Option22": null,
        "Option23": null,
        "Option24": null,
        "BookedDate": "0001-01-01T00:00:00",
        "Salutation": null,
        "Title": null,
        "Function": null,
        "Position": null,
        "BirthDate": null,
        "AdditionalCompany": null,
        "Street": null,
        "PostOffice": null,
        "PostCode": null,
        "City": null,
        "Country": null,
        "Phone": null,
        "PhoneDial": null,
        "Phone2": null,
        "Mobile": null,
        "Fax": null,
        "Url": null,
        "Branch": null,
        "CompanyEmail": null,
        "NewsLetter": null,
        "DbCode": null,
        "TimeOfEntryFrom": null,
        "TimeOfEntryTo": null
    },

    // Here you can find all the general attributes of the ticket buyer. 
    // In case of purchases "organizer" can also mean buyer
    "Organizer": {
        "OrganizerId": 0,
        "AddressId": null,
        "LoginUserId": null,
        "Username": null,
        "BirthDate": null,
        "OrganizerDisplayName": null,
        "UrlWebsite": null,
        "UrlFacebook": null,
        "UrlTwitter": null,
        "UrlInstagram": null,
        "UrlXing": null,
        "UrlLinkedIn": null,
        "BannerImage": null,
        "LogoImage": null,
        "IsNewsletterDoubleOptInProgress": false,
        "Salutation": "",
        "Title": "",
        "FirstName": "",
        "LastName": "",
        "CompanyName": "",
        "Street": "",
        "PostCode": "",
        "City": "",
        "CountryId": 0,
        "LanguageId": null,
        "Phone": "",
        "Mobile": "",
        "Email": "",
        "IBANCode": null,
        "PaymentName": null,
        "PaymentStreet": null,
        "PaymentCity": null,
        "PaymentPostCode": null,
        "PaymentCountryId": null,
        "PostOfficeBox": "",
        "Address2": "",
        "OrganizerType": null,
        "BankIdentifierCode": null,
        "SalesStaffId": null,
        "SupportStaffId": null,
        "CurrencyId": null,
        "InvoiceCost": null,
        "InvoiceCostVat": null,
        "SupressEmailReminder": null,
        "ModifyBuyerAddress": null,
        "IsActive": null,
        "PreventChanges": null,
        "TicketBuyerNewsLetter": null,
        "OrganizerNewsLetter": null,
        "NoVatOnCommission": false,
        "Remarks": null,
    },

    // Here you can find all the general EntryScanned information
    "Id": 0,
    "TimeStamp": "2023-06-02T13:13:21.0089792+02:00",
    "TicketUniqueKey": "116877587566",
    "StatusId": 50,
    "OrganizerId": null,
    "EventId": null,
    "TicketTypeId": null,
    "TicketId": 123,
    "IsDeleted": false,
    "MacAddress": null,
    "DeleteDate": null,
    "DeviceName": null,
    "ExitScan": false
}

Webhook Payloads

Order

Event

TicketType

EntryScanned