Event Hub APIs and WebHooks

Welcome

Please see our list of APIs and webhooks.

Getting your token:

Login to your account inside Event Hub. Down the left menu look for 'settings". Across the top of this page select the EXTERNAL API Tab.
On this page you can reset or Create your token.

AUTHORIZATIONBearer Token

Token

<token>

eventhub-checkout-webhooks

This collection includes webhooks from Sales.

WebHook 1

Sales of Products for an Event or group of events. Essentially hospitality (asset) or ticket sales(seats).

WebHook 2/3

These webhooks refer to Sales of Food ad Beverage or Merchandise products to existing asset owners who are in-app users and buy from in-app URLs.

AUTHORIZATIONBearer Token

This folder is using Bearer Token from collectionEvent Hub APIs and WebHooks

POSTcheck-out-order-payload

customer-endpoint

Asset Sales

Event Hub now supports a full system for sales of assets like rooms and boxes, suites or single or a range of seats.

When a sale is completed a webhook can be sent to any url. This is very similar to the process relating to F&B sales but for sales of "assets" as per above.

The sale of an asset automatically creates the user as an account if NOT exists and adds the owner to our grid system based on event chosen.

AUTHORIZATIONBearer Token

This request is using Bearer Token from collectionEvent Hub APIs and WebHooks

Bodyraw (json)

json

NOTE: we applied multiple prices for seats.
So, if a product (sales_item) has multiple prices, we split it into 2 / 3 / or 4 objects with the `price_type` attribute and different `unit_price` / `units_sold`

{
  “currency”: “string”, // GBP | AUD | USD | NZD | EUR
  “event_id”: “integer", // priava event id
  “event_uuid”: “base64encode of eventhub event id”, // base64encode of EH event id
  “event_name”: “string",
  “order_date”: “2021-06-16T03: 39: 22.001+00: 00",
  “sale_items”: array [
        {
      “price_type”: “string”, // adult | kids | senior | concession or not provided
      “unit_price”: number, // in cents
      “units_sold”: 1, // number
      “facilities_sold”: array [
                {
          “id”: “uuid", // eventhub facility id
          “capacity”: integer, 
          “foreign_facility_id”: “string”, // ubs function id for the facility
          “food_drink_service_point”: “string” // food and drink service point 
                },
            ],
      “facility_ids_sold”: array [
        “uuid”,
            ], // uuid of facilities sold
      “eventhub_sales_item_id”: “uuid” // eventhub sales item id
        }
    ],
  “account_name”: “string“,
  “mobile_number”: “string",
  “account_crm_key”: “string@string”, // eventhub account crm key
  “account_last_name”: “string”,
  “paid_amount_total”: number, // in cents
  “account_first_name”: “string“,
  “foreign_account_id”: number | null, // TP account id
  “eventhub_account_id”: “uuid”, // eventhub account id
  “account_mobile_phone”: “string”,
  “eventhub_order_number”: “string”, // 
  “stripe_transaction_id”: “ch_1J2pb4F7XmARCsUp06RBcAZJ”, // stripe transaction id
  “foreign_sales_order_id”: number, // TP master sales order id
  “eventhub_sales_order_id”: “uuid", // eventhub sales order id
  “account_user_email_address”: “string”,
  “stripe_application_fee_amount”: number // application fee collected by EH
  "account_address": {.                  >>Deprecated????
        "address1": "string",
        "suburb": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postalCode": "varchar"
    },
    "check_out_details": "string",
    "is_individual": "t/f".      :>>>>>>> deprecate replace with
    "sub_type": "SubType".       :>>>>>>> please add 
}

POSTitem-order-payload-ubs

customer-endpoint

AUTHORIZATIONBearer Token

This request is using Bearer Token from collectionEvent Hub APIs and WebHooks

HEADERS

ehaccountid

6b2597c7-fe33-401f-be20-a9cd559ebd66

numberofguests

x-functions-key

abc

latefee

935.25

payloadtype

UBS

ordertype

Bodyraw (json)

json

{
    "Doors": "",
    "Event": 12756,
    "EventDate": "01-04-2024",
    "EventStartTime": "09:00:00",
    "Items": [
        {
            "Units": 10,
            "EndDate": "2021-04-20T09:04:35.045Z",
            "PriceList": "03ME20",
            "StartDate": "2021-04-20T09:04:35.045Z",
            "ItemStatus": "O",
            "UnitCharge": 5.5,
            "ResourceCode": "3FDS118",
            "OrganizationCode": "01",
            "PriceListDetailSeqNbr": 891,
            "ItemDescription": "test"
        },
        {
            "Units": 10,
            "EndDate": "2021-04-20T09:04:35.045Z",
            "PriceList": "MVME21",
            "StartDate": "2021-04-20T09:04:35.045Z",
            "ItemStatus": "O",
            "UnitCharge": 46,
            "ResourceCode": "3F01-OCRSM02",
            "OrganizationCode": "01",
            "PriceListDetailSeqNbr": 1237,
            "ItemDescription": "test"
        },
        {
            "Units": 10,
            "EndDate": "2021-04-20T09:04:35.045Z",
            "PriceList": "MVME21",
            "StartDate": "2021-04-20T09:04:35.045Z",
            "ItemStatus": "O",
            "UnitCharge": 46,
            "ResourceCode": "3B01-4S-00",
            "OrganizationCode": "01",
            "PriceListDetailSeqNbr": 136,
            "ItemDescription": "test"
        }
    ],
    "Space": "31OR26",
    "Account": "00000661",
    "Comments": "",
    "Function": 296,
    "HostAuth": "No",
    "HostName": "Matt hogan",
    "OrderDate": "2021-04-20T09:04:35.045Z",
    "PriceList": "MVME21",
    "GuestNames": "",
    "PaidAmount": 975,
    "AgreementId": "7fba6981-69c4-455f-b9a5-614dffec8af1",
    "ArrivalTime": "5:00pm",
    "OrderNumber": 0,
    "OrderStatus": "A",
    "MobileNumber": "0412115032",
    "PaymentToken": "",
    "UserLastName": "Stewart",
    "BillToAccount": "00000661",
    "UserFirstName": "Matthew",
    "PaymentReceipt": "111009277961",
    "UserMobilePhone": "0448 126 158",
    "OrganizationCode": "01",
    "UserEmailAddress": "matthew.stewart@parraeels.com.au",
    "DietaryRequirements": ""
}