Skip to content
Last updated

This page details all events currently available via the Open API (this list will keep on growing).

Event typeDescriptionDetails
ADDITIONAL_INFORMATION_FIELDS_UPDATEDOccurs whenever an additional information field was updatedentityId is the studioId
AGGREGATOR_MEMBER_CREATEDOccurs whenever an aggregator member was createdentityId is the customerId, content.aggregatorId is the aggregator member id
APPOINTMENT_BOOKING_CANCELLEDOccurs whenever an appointment booking was cancelledentityId is the bookingId
APPOINTMENT_BOOKING_CREATEDOccurs whenever an appointment booking was createdentityId is the bookingId
APPOINTMENT_BOOKING_UPDATEDOccurs whenever an appointment booking time or resource was updatedentityId is the bookingId
AUTOMATIC_CUSTOMER_CHECKOUTOccurs whenever one or multiple customers were automatically checked out from a facilityentityId is the studioId, content is the checkouts object with a list of customerId and checkoutTime pairs, e.g. checkouts:{[{"customerId": 123, "checkoutTime": "2023-10-01T12:00:00Z"}]}
CONTRACT_ADDITIONAL_MODULE_CREATEDOccurs whenever an additional module is created on a customer's contractentityId is the customerId, content.contractId is the id of the main contract, content.moduleContractId is the id of the created additional module contract
CONTRACT_ADDITIONAL_MODULE_DELETEDOccurs whenever an additional module is deleted on a customer's contractentityId is the customerId, content.contractId is the id of the main contract, content.moduleContractId is the id of the deleted additional module contract
CONTRACT_ADDITIONAL_MODULE_UPDATEDOccurs whenever an additional module is updated on a customer's contractentityId is the customerId, content.contractId is the id of the main contract, content.moduleContractId is the id of the updated additional module contract
CONTRACT_ADDITIONAL_MODULE_CANCELLEDOccurs whenever an additional module is cancelled on a customer's contractentityId is the customerId, content.contractId is the id of the main contract, content.moduleContractId is the id of the cancelled additional module contract
CONTRACT_UPDATEDOccurs whenever a contract was changedentityId is the customerId, content.contractId is the id of updated contract
CONTRACT_CREATEDOccurs whenever a main contract was createdentityId is the customerId, content.contractId is the id of created contract
CONTRACT_CANCELLEDOccurs whenever a contract was cancelledentityId is the customerId, content.contractId is the id of cancelled contract
CONTRACT_IDLE_PERIOD_CREATEDOccurs whenever an idle period is created on a customer's contractentityId is the customerId, content.contractId is the id of the contract, content.idlePeriodId is the id of the created idle period
CONTRACT_IDLE_PERIOD_CANCELLEDOccurs whenever an idle period is removed on a customer's contractentityId is the customerId, content.contractId is the id of the contract, content.idlePeriodId is the id of the cancelled idle period
CONTRACT_IDLE_PERIOD_UPDATEDOccurs whenever an idle period is updated on a customer's contractentityId is the customerId, content.contractId is the id of the contract, content.idlePeriodId is the id of the updated idle period
CUSTOMER_ACCESS_MEDIUM_CREATEDOccurs whenever an access medium is created for a customerentityId is the customerId
CUSTOMER_ACCESS_MEDIUM_UPDATEDOccurs whenever an access medium is updated for a customerentityId is the customerId
CUSTOMER_ACCESS_MEDIUM_DELETEDOccurs whenever an access medium is removed for a customerentityId is the customerId
CUSTOMER_ACCESS_RESTRICTION_CREATEDOccurs whenever an access restriction is created for a customerentityId is the customerId
CUSTOMER_ACCESS_RESTRICTION_DELETEDOccurs whenever an access restriction is removed for a customerentityId is the customerId
CUSTOMER_CHECKINOccurs whenever a customer has physically checked in at a facilityentityId is the customerId
CUSTOMER_CHECKOUTOccurs whenever a customer has physically checked out from a facilityentityId is the customerId
CUSTOMER_CHECKIN_STUDIOS_UPDATEDOccurs whenever the checkin studios are updated for a customerentityId is the customerId
CUSTOMER_CREATEDOccurs whenever a customer has been created at a facilityentityId is the customerId
CUSTOMER_DELETEDOccurs whenever a customer has been deletedentityId is the customerId
CUSTOMER_UPDATEDOccurs whenever a customer's data has been changedentityId is the customerId
CUSTOMER_COMMUNICATION_PREFERENCES_UPDATEDOccurs whenever a customer's communication preferences are updatedentityId is the customerId
CUSTOMER_ACCESS_DISABLEDOccurs whenever a customer's access was disabled. It is not possible to request customer data after this event.entityId is the customerId
CLASS_BOOKING_CANCELLEDOccurs whenever a class booking was cancelledentityId is the bookingId
CLASS_BOOKING_CREATEDOccurs whenever a class booking was createdentityId is the bookingId
CLASS_BOOKING_UPDATEDOccurs whenever a class booking was updatedentityId is the bookingId
CLASS_SLOT_CANCELLEDOccurs whenever a class slot was cancelledentityId is the classSlotId, content.classId is the id of belonging class
CLASS_SLOT_UPDATEDOccurs whenever a class slot time or resource was updatedentityId is the classSlotId, content.classId is the id of belonging class
DEVICE_CREATEDOccurs whenever a device was createdentityId is the deviceId
EMPLOYEE_CREATEDOccurs whenever a employee has been created at a facilityentityId is the employeeId
EMPLOYEE_DELETEDOccurs whenever a employee has been deletedentityId is the employeeId
EMPLOYEE_UPDATEDOccurs whenever a employee's data has been changedentityId is the employeeId
FINANCE_DEBT_COLLECTION_RUN_CREATEDOccurs whenever a debt collection run was createdentityId is the debtCollectionRunId
FINANCE_DEBT_COLLECTION_CONFIGURATION_UPDATEDOccurs whenever the debt collection configuration was updated
FINANCE_DEBT_COLLECTION_CASE_UPDATEDOccurs whenever a debt collection case was updatedentityId is the caseAdjustmentRequestId. Content additionally contains the agencyDebtCollectionCaseId if set, or else the collectionCaseId
STUDIO_OPENING_HOURS_UPDATEDOccurs whenever the opening hours are updated for a studioentityId is the studioId
TAX_ADVISOR_EXPORT_CREATEDOccurs whenever a tax advisor export was createdentityId is the exportId