Change log
This change log lists changes to the EventsAir GraphQL API over time including GraphQL API schema changes and bug fixes.
Changes to the API might affect existing integrated applications and require action from you to test and update them.
Where possible, advanced notice of changes will be published in planned breaking changes to provide you time to change your applications.
GraphQL API schema change are annotated as follows:
❌ Breaking change: Indicates a change that can break compatibility with an application, such as removing a field from a query.
⚠️ Dangerous change: Indicates a change that could affect the runtime behavior of an applications, such as adding an enum value.
✅ Non-breaking change: Indicates a change that will not break compatibility with existing applications, such as the additional of a new field, type, query or mutation.
2024-11-25
Key feature changes
The following key features have been added or modified. Please refer to the detailed GraphQL API schema changes following for further details.
- Added queries and mutations to support recording agenda item attendance in an event.
- Added new mutations to create and update contacts in contact stores.
- Added new fields
secondaryAddress
,useSecondaryAddress
,suffix
andtaxNumber
to theContact
type. - Added new input fields
secondaryAddress
,useSecondaryAddress
andsuffix
to theCreateContactInput
andUpdateContactDetailsInput
types. - Added a new field
purchaseOrderNumber
to theInvoice
type. - Added new filter option
payableItemIds
toInvoiceSearchFilterInput
.
Bug fixes
- Fixed an issue where
updateEventNote
,updateContactStoreNote
,updateCeContactStoreNote
andupdateMembershipContactStoreNote
mutations didn't updatecustomFields
. - Fixed an issue where filtering
contacts
withcontacts.registrationFilter.dateRegistered
filter returned an incorrect result.
GraphQL API schema changes
⚠️ Dangerous changes
- Input field
payableItemIds
of type[ID!]
was added to input object typeInvoiceSearchFilterInput
. - Input field
secondaryAddress
of typeAddressInput
was added to input object typeCreateContactInput
. - Input field
suffix
of typeString
was added to input object typeCreateContactInput
. - Input field
useSecondaryAddress
of typeBoolean
was added to input object typeCreateContactInput
. - Input field
secondaryAddress
of typeAddressInput
was added to input object typeUpdateContactDetailsInput
. - Input field
suffix
of typeString
was added to input object typeUpdateContactDetailsInput
. - Input field
useSecondaryAddress
of typeBoolean
was added to input object typeUpdateContactDetailsInput
.
✅ Non-breaking changes
- Field
agendaItemAttendances
was added to object typeContact
. - Field
secondaryAddress
was added to object typeContact
. - Field
suffix
was added to object typeContact
. - Field
taxNumber
was added to object typeContact
. - Field
useSecondaryAddress
was added to object typeContact
. - Field
createAgendaItemAttendance
was added to object typeMutation
. - Field
createCeContactStoreContact
was added to object typeMutation
. - Field
createContactStoreContact
was added to object typeMutation
. - Field
createMembershipContactStoreContact
was added to object typeMutation
. - Field
deleteAgendaItemAttendance
was added to object typeMutation
. - Field
updateCeContactStoreContactBilling
was added to object typeMutation
. - Field
updateCeContactStoreContactDetails
was added to object typeMutation
. - Field
updateContactStoreContactBilling
was added to object typeMutation
. - Field
updateContactStoreContactDetails
was added to object typeMutation
. - Field
updateMembershipContactStoreContactBilling
was added to object typeMutation
. - Field
updateMembershipContactStoreContactDetails
was added to object typeMutation
. - Field
secondaryAddress
was added to object typeCeContactStoreContact
. - Field
suffix
was added to object typeCeContactStoreContact
. - Field
taxNumber
was added to object typeCeContactStoreContact
. - Field
useSecondaryAddress
was added to object typeCeContactStoreContact
. - Field
agendaItemAttendances
was added to object typeEvent
. - Field
secondaryAddress
was added to object typeContactStoreContact
. - Field
suffix
was added to object typeContactStoreContact
. - Field
taxNumber
was added to object typeContactStoreContact
. - Field
useSecondaryAddress
was added to object typeContactStoreContact
. - Field
purchaseOrderNumber
was added to object typeInvoice
. - Field
secondaryAddress
was added to object typeMembershipContactStoreContact
. - Field
suffix
was added to object typeMembershipContactStoreContact
. - Field
taxNumber
was added to object typeMembershipContactStoreContact
. - Field
useSecondaryAddress
was added to object typeMembershipContactStoreContact
. - Type
ActivityBreakAttendanceAgendaItem
was added. - Type
AgendaItemAttendance
was added. - Type
AgendaItemAttendanceSearchFilterInput
was added. - Type
AgendaItemCheckInStatus
was added. - Type
AgendaItemCheckOutStatus
was added. - Type
AttendanceAgendaItem
was added. - Type
AttendanceAgendaItemSearchFilterInput
was added. - Type
AttendanceAgendaItemTrackSearchFilterInput
was added. - Type
AttendanceAgendaItemType
was added. - Type
CreateAgendaItemAttendanceInput
was added. - Type
CreateAgendaItemAttendancePayload
was added. - Type
CreateCeContactStoreContactInput
was added. - Type
CreateCeContactStoreContactPayload
was added. - Type
CreateContactStoreContactInput
was added. - Type
CreateContactStoreContactPayload
was added. - Type
CreateMembershipContactStoreContactInput
was added. - Type
CreateMembershipContactStoreContactPayload
was added. - Type
DeleteAgendaItemAttendanceInput
was added. - Type
DeleteAgendaItemAttendancePayload
was added. - Type
SessionAttendanceAgendaItem
was added. - Type
UpdateCeContactStoreContactBillingInput
was added. - Type
UpdateCeContactStoreContactBillingPayload
was added. - Type
UpdateCeContactStoreContactDetailsInput
was added. - Type
UpdateCeContactStoreContactDetailsPayload
was added. - Type
UpdateContactStoreContactBillingInput
was added. - Type
UpdateContactStoreContactBillingPayload
was added. - Type
UpdateContactStoreContactDetailsInput
was added. - Type
UpdateContactStoreContactDetailsPayload
was added. - Type
UpdateMembershipContactStoreContactBillingInput
was added. - Type
UpdateMembershipContactStoreContactBillingPayload
was added. - Type
UpdateMembershipContactStoreContactDetailsInput
was added. - Type
UpdateMembershipContactStoreContactDetailsPayload
was added.
2024-11-05
Key feature changes
The following key features have been added or modified. Please refer to the detailed GraphQL API schema changes following for further details.
- Added support for retrieving
profile
andbrochures
ofcontact.exhibitionBookings
andcontact.sponsorships
. - Added support for retrieving the
appPin
of acontact.onlineUser
. - Added support for retrieving
locations
in membership and continuing education stores.
GraphQL API schema changes
✅ Non-breaking changes
- Field
locations
was added to object typeCeContactStoreSetup
. - Field
profile
was added to object typeExhibitionBooking
. - Field
brochures
was added to object typeExhibitionBooking
. - Field
locations
was added to object typeMembershipContactStoreSetup
. - Field
appPin
was added to object typeOnlineUser
. - Field
profile
was added to object typeSponsorship
. - Field
brochures
was added to object typeSponsorship
. - Type
Brochure
was added. - Type
BrochureDetails
was added. - Type
PdfBrochureDetails
was added. - Type
UrlBrochureDetails
was added. - Type
VideoUrlBrochureDetails
was added.
2024-09-19
Key feature changes
The following key features have been added or modified. Please refer to the detailed GraphQL API schema changes following for further details.
- Added new filter option
tracks
toFunctionRegistrationFunctionSearchFilterInput
. - The field
PresentationSetup.locations
has been deprecated. Please use the new fieldEventSetup.locations
.PresentationSetup.locations
will be removed in a future release.
GraphQL API schema changes
⚠️ Dangerous changes
- Input field
tracks
of type[Int!]
was added to input object typeFunctionRegistrationFunctionSearchFilterInput
.
✅ Non-breaking changes
- Directive
deprecated
was added to fieldPresentationSetup.locations
. - Field
locations
was added to object typeEventSetup
.
2024-09-12
Key feature changes
The following key features have been added or modified. Please refer to the detailed GraphQL API schema changes following for further details.
-
Added the ability to filter data through an argument for the following fields:
CeContactStore.functionRegistrations
Contact.functionRegistrations
Contact.registrations
Event.functionRegistrations
Event.registrations
Function.feeTypes
FunctionSetup.functions
MembershipContactStore.functionRegistrations
MembershipContactStoreContact.functionRegistrations
Query.payableItems
-
Extended the filter options for events and contact stores.
-
The argument
input
of fieldEvent.functionRegistrations
has been deprecated. Please use the new argumentfilterInput
instead.input
will be removed in a future release. -
The argument
input
of fieldEvent.registrations
has been deprecated. Please use the new argumentfilterInput
instead.input
will be removed in a future release.
GraphQL API schema changes
⚠️ Dangerous changes
- Argument
input: FunctionFeeTypeSearchFilterInput!
(with default value) added to fieldFunction.feeTypes
. - Argument
input: RegistrationSearchFilterInput!
(with default value) added to fieldContact.registrations
. - Argument
input: FunctionRegistrationSearchFilterInput!
(with default value) added to fieldContact.functionRegistrations
. - Argument
input: PayableItemSearchFilterInput!
(with default value) added to fieldQuery.payableItems
. - Argument
input: FunctionRegistrationSearchFilterInput!
(with default value) added to fieldCeContactStore.functionRegistrations
. - Argument
filterInput: RegistrationSearchFilterInput!
(with default value) added to fieldEvent.registrations
. - Argument
filterInput: FunctionRegistrationSearchFilterInput!
(with default value) added to fieldEvent.functionRegistrations
. - Argument
input: FunctionSearchFilterInput!
(with default value) added to fieldFunctionSetup.functions
. - Argument
input: FunctionRegistrationSearchFilterInput!
(with default value) added to fieldMembershipContactStore.functionRegistrations
. - Argument
input: FunctionRegistrationSearchFilterInput!
(with default value) added to fieldMembershipContactStoreContact.functionRegistrations
. - Input field
aliases
of type[String!]
was added to input object typeContactStoresWhere
. - Input field
office
of typeOfficeWhere
was added to input object typeContactStoresWhere
. - Input field
uniqueCodes
of type[String!]
was added to input object typeContactStoresWhere
. - Input field
aliases
of type[String!]
was added to input object typeEventsWhere
. - Input field
group
of typeEventGroupWhere
was added to input object typeEventsWhere
. - Input field
office
of typeOfficeWhere
was added to input object typeEventsWhere
. - Input field
uniqueCodes
of type[String!]
was added to input object typeEventsWhere
. - Input field
isExported
of typeBoolean
was added to input object typeInvoiceSearchFilterInput
. - Input field
isExported
of typeBoolean
was added to input object typePaymentSearchFilterInput
.
✅ Non-breaking changes
- Directive
deprecated
was added to argumentinput
of fieldEvent.functionRegistrations
. - Directive
deprecated
was added to argumentinput
of fieldEvent.registrations
. - Type
EventGroupWhere
was added. - Type
FunctionFeeTypeSearchFilterInput
was added. - Type
FunctionFunctionFeeTypeSearchFilterInput
was added. - Type
FunctionFunctionGroupSearchFilterInput
was added. - Type
FunctionRegistrationFunctionFeeTypeSearchFilterInput
was added. - Type
FunctionRegistrationFunctionGroupSearchFilterInput
was added. - Type
FunctionRegistrationFunctionLocationSearchFilterInput
was added. - Type
FunctionRegistrationFunctionSearchFilterInput
was added. - Type
FunctionRegistrationSearchFilterInput
was added. - Type
FunctionSearchFilterInput
was added. - Type
OfficeWhere
was added. - Type
OpenEndedDecimalRangeFilter
was added. - Type
PayableItemSearchFilterInput
was added. - Type
RegistrationGroupSearchFilterInput
was added. - Type
RegistrationSearchFilterInput
was added. - Type
RegistrationTypeSearchFilterInput
was added.
2024-08-27
Key feature changes
The following key features have been added or modified. Please refer to the detailed GraphQL API schema changes following for further details.
-
Added the ability to filter data through an argument for the following fields:
Query.invoices
Query.journals
Query.payments
GloballyScopedCustomFieldDefinitions.events
-
Added mutations and queries to support sending email communications using merge documents.
Bug fixes
- Fixed an issue where queries that included an
EmailAddress
field threw an error if the email address in the result set contained invalid characters. Invalid email addresses are now replaced bynull
. - Fixed an issue when in certain conditions
Mutation.updateEvent
threw an unexpected error.
GraphQL API schema changes
⚠️ Dangerous changes
- Argument
input: InvoiceSearchFilterInput!
(with default value) added to fieldQuery.invoices
. - Argument
input: JournalSearchFilterInput!
(with default value) added to fieldQuery.journals
. - Argument
input: PaymentSearchFilterInput!
(with default value) added to fieldQuery.payments
. - Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldGloballyScopedCustomFieldDefinitions.events
.
✅ Non-breaking changes
- Field
createCommunicationTag
was added to object typeMutation
. - Field
queueEmailCommunication
was added to object typeMutation
. - Field
communicationTags
was added to object typeCeContactStore
. - Field
mergeDocuments
was added to object typeCeContactStore
. - Field
communicationTags
was added to object typeContactStore
. - Field
mergeDocuments
was added to object typeContactStore
. - Field
communicationTags
was added to object typeEvent
. - Field
mergeDocuments
was added to object typeEvent
. - Field
communicationTags
was added to object typeMembershipContactStore
. - Field
mergeDocuments
was added to object typeMembershipContactStore
. - Type
CommunicationTag
was added. - Type
CreateCommunicationTagInput
was added. - Type
CreateCommunicationTagPayload
was added. - Type
JournalSearchFilterInput
was added. - Type
MergeDocument
was added. - Type
MergeDocumentDateFormat
was added. - Type
MergeDocumentType
was added. - Type
QueueEmailCommunicationInput
was added. - Type
QueueEmailCommunicationPayload
was added.
2024-08-07
Key feature changes
The following feature was added. Please refer to the detailed GraphQL API schema changes following for further details.
- Added a new field,
billingRecipient
, to theInvoiceRecipient
type, that returns billing details for the invoice recipient.
Bug fixes
- Fixed an issue where event queries (
Query.events
) were including archived events by default. To include archived events, use theincludeArchivedEvents
input field on theEventsWhere
input.
GraphQL API schema changes
✅ Non-breaking changes
- Field
billingRecipient
was added to object typeInvoiceRecipient
. - Type
InvoiceBillingRecipient
was added. - Type
InvoiceBillingRecipientAddress
was added.
2024-07-30
Key feature changes
The following key features have been added or modified. Please refer to the detailed GraphQL API schema changes following for further details.
- Added the ability to filter data through an input field for the following fields:
CeContactStoreContact.notes
Contact.exhibitionBookings
Contact.notes
Contact.presentations
Contact.sponsorships
ContactStoreContact.notes
Event.exhibitionBookings
Event.presentations
Event.sessions
Event.sponsorships
EventAgenda.items
MembershipContactStoreContact.notes
- Added the ability to mark payments and invoices as exported for events, continuing education contact stores, and membership contact stores.
GraphQL API schema changes
⚠️ Dangerous changes
- Argument
input: NoteSearchFilterInput!
(with default value) added to fieldCeContactStoreContact.notes
. - Argument
input: ExhibitionBookingSearchFilterInput!
(with default value) added to fieldContact.exhibitionBookings
. - Argument
input: NoteSearchFilterInput!
(with default value) added to fieldContact.notes
. - Argument
input: PresentationSearchFilterInput!
(with default value) added to fieldContact.presentations
. - Argument
input: SponsorshipSearchFilterInput!
(with default value) added to fieldContact.sponsorships
. - Argument
input: NoteSearchFilterInput!
(with default value) added to fieldContactStoreContact.notes
. - Argument
input: ExhibitionBookingSearchFilterInput!
(with default value) added to fieldEvent.exhibitionBookings
. - Argument
input: PresentationSearchFilterInput!
(with default value) added to fieldEvent.presentations
. - Argument
input: SessionSearchFilterInput!
(with default value) added to fieldEvent.sessions
. - Argument
input: SponsorshipSearchFilterInput!
(with default value) added to fieldEvent.sponsorships
. - Argument
input: EventAgendaItemSearchFilterInput!
(with default value) added to fieldEventAgenda.items
. - Argument
input: NoteSearchFilterInput!
(with default value) added to fieldMembershipContactStoreContact.notes
. - Input field
userDefinedField1
of typeString
was added to input object typeContactFilterInput
. - Input field
userDefinedField2
of typeString
was added to input object typeContactFilterInput
. - Input field
userDefinedField3
of typeString
was added to input object typeContactFilterInput
. - Input field
userDefinedField4
of typeString
was added to input object typeContactFilterInput
.
✅ Non-breaking changes
- Field
markCeContactStoreInvoicesAsExported
was added to object typeMutation
. - Field
markCeContactStorePaymentsAsExported
was added to object typeMutation
. - Field
markEventInvoicesAsExported
was added to object typeMutation
. - Field
markEventPaymentsAsExported
was added to object typeMutation
. - Field
markMembershipContactStoreInvoicesAsExported
was added to object typeMutation
. - Field
markMembershipContactStorePaymentsAsExported
was added to object typeMutation
. - Type
EventAgendaItemSearchFilterInput
was added. - Type
EventAgendaItemTrackSearchFilterInput
was added. - Type
ExhibitionBookingPaymentDetailsSearchFilterInput
was added. - Type
ExhibitionBookingSearchFilterInput
was added. - Type
ExhibitionBookingStandSearchFilterInput
was added. - Type
ExhibitionBookingStandTypeSearchFilterInput
was added. - Type
MarkCeContactStoreInvoicesAsExportedInput
was added. - Type
MarkCeContactStoreInvoicesAsExportedPayload
was added. - Type
MarkCeContactStorePaymentsAsExportedInput
was added. - Type
MarkCeContactStorePaymentsAsExportedPayload
was added. - Type
MarkEventInvoicesAsExportedInput
was added. - Type
MarkEventInvoicesAsExportedPayload
was added. - Type
MarkEventPaymentsAsExportedInput
was added. - Type
MarkEventPaymentsAsExportedPayload
was added. - Type
MarkMembershipContactStoreInvoicesAsExportedInput
was added. - Type
MarkMembershipContactStoreInvoicesAsExportedPayload
was added. - Type
MarkMembershipContactStorePaymentsAsExportedInput
was added. - Type
MarkMembershipContactStorePaymentsAsExportedPayload
was added. - Type
NoteSearchFilterInput
was added. - Type
NoteTypeSearchFilterInput
was added. - Type
PresentationKeywordSearchFilterInput
was added. - Type
PresentationPaperStatusSearchFilterInput
was added. - Type
PresentationSearchFilterInput
was added. - Type
PresentationSessionSearchFilterInput
was added. - Type
PresentationSubThemeSearchFilterInput
was added. - Type
PresentationThemeSearchFilterInput
was added. - Type
PresentationTypeSearchFilterInput
was added. - Type
SessionBlockSearchFilterInput
was added. - Type
SessionLocationSearchFilterInput
was added. - Type
SessionSearchFilterInput
was added. - Type
SessionTrackSearchFilterInput
was added. - Type
SponsorshipPackageSearchFilterInput
was added. - Type
SponsorshipPaymentDetailsSearchFilterInput
was added. - Type
SponsorshipSearchFilterInput
was added.
2024-07-05
Key feature changes
The following key features have been added or modified. Please refer to the detailed GraphQL API schema changes following for further details.
- Added the ability to get a contact by its identifier through the
CeContactStore.contact
,ContactStore.contact
,Event.contact
, andMembershipContactStore.contact
fields. - Added support for retrieving an exhibition booking or a registration by its identifier through the
Event.exhibitionBooking
andEvent.registration
fields. - Added the ability to retrieve invoices and payments in the context of an event, a Continuing Education contact store, or a membership store.
- Added the ability to get an invoice or a payment by its identifier in the context of an event, a Continuing Education contact store, or a membership store.
- Added social media links to contacts in events, Continuing Education contact stores, and membership with a new
socialMedia
field on the relevant contact type. - Added support for specifying social media links during the creation and update of contacts with a new
socialMedia
input field on theCreateContactInput
andUpdateContactInput
input types.
GraphQL API schema changes
⚠️ Dangerous changes
- Input field
socialMedia
of typeContactSocialMediaInput
was added to input object typeCreateContactInput
. - Input field
socialMedia
of typeContactSocialMediaInput
was added to input object typeUpdateContactInput
.
✅ Non-breaking changes
- Field
contact
was added to object typeCeContactStore
. - Field
invoice
was added to object typeCeContactStore
. - Field
invoices
was added to object typeCeContactStore
. - Field
payment
was added to object typeCeContactStore
. - Field
payments
was added to object typeCeContactStore
. - Field
socialMedia
was added to object typeCeContactStoreContact
. - Field
socialMedia
was added to object typeContact
. - Field
contact
was added to object typeContactStore
. - Field
contact
was added to object typeEvent
. - Field
exhibitionBooking
was added to object typeEvent
. - Field
invoice
was added to object typeEvent
. - Field
invoices
was added to object typeEvent
. - Field
payment
was added to object typeEvent
. - Field
payments
was added to object typeEvent
. - Field
registration
was added to object typeEvent
. - Field
contact
was added to object typeMembershipContactStore
. - Field
invoice
was added to object typeMembershipContactStore
. - Field
invoices
was added to object typeMembershipContactStore
. - Field
payment
was added to object typeMembershipContactStore
. - Field
payments
was added to object typeMembershipContactStore
. - Field
socialMedia
was added to object typeMembershipContactStoreContact
. - Type
ContactSocialMedia
was added. - Type
ContactSocialMediaInput
was added.
2024-06-18
Bug fixes
- Fixed an issue where the
offset
andlimit
arguments were ignored for theEventMarketingSetup.groups
,ContactStoreMarketingSetup.groups
,CeContactStoreMarketingSetup.groups
, andMembershipContactStoreMarketingSetup.groups
fields. - Fixed an issue where
Event.exhibitionBookings
andContact.exhibitionBookings
fields returned exhibition bookings associated with deleted contacts.
2024-06-07
Key feature changes
The following key features have been added or modified. Please refer to the detailed GraphQL API schema changes following for further details.
- Introduced a breaking change where the
InvoiceLineItem.payableItem
andPaymentLineItem.payableItem
fields changed type fromPayableItem!
toPayableItem
, meaning they are now nullable. - Added support for webhooks. Please note that webhooks in EventsAir are a subscription service with a recurring licence fee. For more information see the webhooks guide.
- Added support for uploading presentation documents in the
createPresentation
andupdatePresentation
mutations through theattachedDocuments
input field. For more information see the file upload guide. - Attendance-related changes for events, functions, and sessions:
- Added mutations to perform check-in and check-out operations.
- Added new fields to get check-in and check-out dates for attendees.
- Deprecated the
attachedDocumentIds
input field on both theCreatePresentationInput
andUpdatePresentationInput
input types.
GraphQL API schema changes
❌ Breaking changes
- Field
InvoiceLineItem.payableItem
changed type fromPayableItem!
toPayableItem
. - Field
PaymentLineItem.payableItem
changed type fromPayableItem!
toPayableItem
.
⚠️ Dangerous changes
- Input field
attachedDocuments
of type[CreatePresentationAttachedDocumentInput!]
was added to input object typeCreatePresentationInput
. - Input field
attachedDocuments
of type[UpdatePresentationAttachedDocumentInput!]
was added to input object typeUpdatePresentationInput
.
✅ Non-breaking changes
- Field
checkOutDate
was added to object typeContact
. - Field
attendances
was added to object typeFunction
. - Field
checkInDate
was added to object typeFunctionRegistration
. - Field
checkOutDate
was added to object typeFunctionRegistration
. - Field
checkIntoEvent
was added to object typeMutation
. - Field
checkIntoFunction
was added to object typeMutation
. - Field
checkIntoSession
was added to object typeMutation
. - Field
checkOutOfEvent
was added to object typeMutation
. - Field
checkOutOfFunction
was added to object typeMutation
. - Field
checkOutOfSession
was added to object typeMutation
. - Field
createWebhookSubscription
was added to object typeMutation
. - Field
deleteWebhookSubscription
was added to object typeMutation
. - Field
disableWebhookSubscription
was added to object typeMutation
. - Field
enableWebhookSubscription
was added to object typeMutation
. - Field
generateWebhookManagementPortalUrl
was added to object typeMutation
. - Field
updateWebhookSubscription
was added to object typeMutation
. - Field
webhookEventType
was added to object typeQuery
. - Field
webhookEventTypes
was added to object typeQuery
. - Field
webhookMessageDeliveryAttempts
was added to object typeQuery
. - Field
webhookMessages
was added to object typeQuery
. - Field
webhookSubscription
was added to object typeQuery
. - Field
webhookSubscriptionSecret
was added to object typeQuery
. - Field
webhookSubscriptions
was added to object typeQuery
. - Field
attendances
was added to object typeSession
. - Type
CheckIntoEventInput
was added. - Type
CheckIntoEventPayload
was added. - Type
CheckIntoFunctionInput
was added. - Type
CheckIntoFunctionPayload
was added. - Type
CheckIntoSessionInput
was added. - Type
CheckIntoSessionPayload
was added. - Type
CheckOutOfEventInput
was added. - Type
CheckOutOfEventPayload
was added. - Type
CheckOutOfFunctionInput
was added. - Type
CheckOutOfFunctionPayload
was added. - Type
CheckOutOfSessionInput
was added. - Type
CheckOutOfSessionPayload
was added. - Type
CreatePresentationAttachedDocumentInput
was added. - Type
CreateWebhookSubscriptionInput
was added. - Type
CreateWebhookSubscriptionPayload
was added. - Type
DeleteWebhookSubscriptionInput
was added. - Type
DeleteWebhookSubscriptionPayload
was added. - Type
DisableWebhookSubscriptionInput
was added. - Type
DisableWebhookSubscriptionPayload
was added. - Type
EnableWebhookSubscriptionInput
was added. - Type
EnableWebhookSubscriptionPayload
was added. - Type
FunctionAttendance
was added. - Type
GenerateWebhookManagementPortalUrlPayload
was added. - Type
PageInfo
was added. - Type
SessionAttendance
was added. - Type
UpdatePresentationAttachedDocumentInput
was added. - Type
UpdateWebhookSubscriptionInput
was added. - Type
UpdateWebhookSubscriptionPayload
was added. - Type
WebhookEventType
was added. - Type
WebhookEventTypeConnection
was added. - Type
WebhookEventTypeEdge
was added. - Type
WebhookMessage
was added. - Type
WebhookMessageConnection
was added. - Type
WebhookMessageDeliveryAttempt
was added. - Type
WebhookMessageDeliveryAttemptConnection
was added. - Type
WebhookMessageDeliveryAttemptEdge
was added. - Type
WebhookMessageDeliveryAttemptTriggerType
was added. - Type
WebhookMessageDeliveryStatus
was added. - Type
WebhookMessageEdge
was added. - Type
WebhookSubscription
was added. - Type
WebhookSubscriptionConnection
was added. - Type
WebhookSubscriptionEdge
was added. - Type
WebhookSubscriptionFilter
was added. - Type
WebhookSubscriptionFilterInput
was added. - Type
WebhookSubscriptionFilterType
was added. - Type
WebhookSubscriptionSecret
was added.
2024-05-27
Key feature changes
The following key features have been added or modified. Please refer to the detailed GraphQL API schema changes following for further details.
- Increased the hourly GraphQL operation cost limit from 500,000 to 1,000,000. See Usage limits for more details.
- Added queries and mutations to create and release temporary holds for inventories of registrations, function registrations and their associated discount codes. For more information see the Inventories guide.
- Added new filtering options for custom fields. You can now query custom fields based on their
definitionIds
,names
oruniqueCodes
. For more details seeCustomFieldSearchFilterInput
used in these queries.
GraphQL API schema changes
⚠️ Dangerous changes
- Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldCeContactStore.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldCeContactStoreContact.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldContactStore.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldContactStoreContact.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldContact.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldFunctionEventAgendaItem.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldSessionEventAgendaItem.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldEvent.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldExhibitionStandType.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldExhibitionBooking.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldFunctionRegistration.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldFunction.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldFunctionGroup.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldFunctionFeeType.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldEventMarketingRecord.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldEventMarketingGroup.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldEventMarketingTag.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldEventMarketingSubTag.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldContactStoreMarketingRecord.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldCeContactStoreMarketingRecord.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldMembershipContactStoreMarketingRecord.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldMembershipContactStore.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldMembershipContactStoreContact.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldEventNoteType.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldEventNote.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldContactStoreNote.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldCeContactStoreNote.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldMembershipContactStoreNote.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldPresentation.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldRegistrationType.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldRegistrationGroup.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldRegistration.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldSession.customFields
. - Argument
input: CustomFieldSearchFilterInput!
(with default value) added to fieldSessionRole.customFields
. - Input field
temporaryHoldContextId
of typeID
was added to input object typeCreateRegistrationInput
. - Input field
temporaryHoldContextId
of typeID
was added to input object typeCreateFunctionRegistrationInput
. - Input field
temporaryHoldContextId
of typeID
was added to input object typeCreateFunctionRegistrationWithBasicGuestsInput
. - Input field
temporaryHoldContextId
of typeID
was added to input object typeCreateFunctionRegistrationWithContactGuestsInput
. - Input field
temporaryHoldContextId
of typeID
was added to input object typeUpdateFunctionRegistrationInput
. - Input field
temporaryHoldContextId
of typeID
was added to input object typeUpdateFunctionRegistrationWithBasicGuestsInput
. - Input field
temporaryHoldContextId
of typeID
was added to input object typeUpdateFunctionRegistrationWithContactGuestsInput
.
✅ Non-breaking changes
- Field
inventory
was added to object typeFunctionDiscountCode
. - Field
inventory
was added to object typeFunctionFeeType
. - Field
inventory
was added to object typeRegistrationDiscountCode
. - Field
inventory
was added to object typeRegistrationType
. - Field
createTemporaryHoldForFunctionDiscountCode
was added to object typeMutation
. - Field
createTemporaryHoldForFunctionRegistration
was added to object typeMutation
. - Field
createTemporaryHoldForRegistration
was added to object typeMutation
. - Field
createTemporaryHoldForRegistrationDiscountCode
was added to object typeMutation
. - Field
releaseTemporaryHoldForFunctionDiscountCode
was added to object typeMutation
. - Field
releaseTemporaryHoldForFunctionRegistration
was added to object typeMutation
. - Field
releaseTemporaryHoldForRegistration
was added to object typeMutation
. - Field
releaseTemporaryHoldForRegistrationDiscountCode
was added to object typeMutation
. - Type
CreateTemporaryHoldForFunctionDiscountCodeInput
was added. - Type
CreateTemporaryHoldForFunctionDiscountCodePayload
was added. - Type
CreateTemporaryHoldForFunctionRegistrationInput
was added. - Type
CreateTemporaryHoldForFunctionRegistrationPayload
was added. - Type
CreateTemporaryHoldForRegistrationDiscountCodeInput
was added. - Type
CreateTemporaryHoldForRegistrationDiscountCodePayload
was added. - Type
CreateTemporaryHoldForRegistrationInput
was added. - Type
CreateTemporaryHoldForRegistrationPayload
was added. - Type
CustomFieldSearchFilterInput
was added. - Type
FunctionFeeTypeInventory
was added. - Type
Inventory
was added. - Type
RegistrationTypeInventory
was added. - Type
ReleaseTemporaryHoldForFunctionDiscountCodeInput
was added. - Type
ReleaseTemporaryHoldForFunctionDiscountCodePayload
was added. - Type
ReleaseTemporaryHoldForFunctionRegistrationInput
was added. - Type
ReleaseTemporaryHoldForFunctionRegistrationPayload
was added. - Type
ReleaseTemporaryHoldForRegistrationDiscountCodeInput
was added. - Type
ReleaseTemporaryHoldForRegistrationDiscountCodePayload
was added. - Type
ReleaseTemporaryHoldForRegistrationInput
was added. - Type
ReleaseTemporaryHoldForRegistrationPayload
was added.
2024-05-07
Key feature changes
The following key features have been added or modified. Please refer to the detailed GraphQL API schema changes following for further details.
- Added queries and mutations to support marketing records (also known as marketing tags).
- Added queries and mutations to support notes.
- Added queries and mutations to support membership records in a membership contact store.
- Added new filtering options for custom field definitions. You can now query custom field definitions based on their
customFieldDefinitionIds
,names
oruniqueCodes
. For more details seeCustomFieldDefinitionSearchFilterInput
used in these queries. This input can be used to filter custom field definitions in the scope of events, contact stores, continuing education contact stores and membership contact stores. - Modified how the HTTP request limit for the GraphQL API are applied. Now up to 750 HTTP requests over a 5-minute window are allowed.
GraphQL API schema changes
❌ Breaking changes
- Field
_internal
(deprecated) was removed from object typeContactStoreSetup
.
⚠️ Dangerous changes
- Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldCeContactStoreScopedCustomFieldDefinitions.contacts
. - Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldCeContactStoreScopedCustomFieldDefinitions.functionGroups
. - Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldCeContactStoreScopedCustomFieldDefinitions.functionFeeTypes
. - Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldCeContactStoreScopedCustomFieldDefinitions.functions
. - Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldCeContactStoreScopedCustomFieldDefinitions.functionRegistrations
. - Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldContactStoreScopedCustomFieldDefinitions.contacts
. - Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldEventScopedCustomFieldDefinitions.contacts
. - Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldEventScopedCustomFieldDefinitions.exhibitionBookings
. - Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldEventScopedCustomFieldDefinitions.exhibitionStandTypes
. - Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldEventScopedCustomFieldDefinitions.functionGroups
. - Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldEventScopedCustomFieldDefinitions.functionFeeTypes
. - Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldEventScopedCustomFieldDefinitions.functions
. - Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldEventScopedCustomFieldDefinitions.functionRegistrations
. - Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldEventScopedCustomFieldDefinitions.presentations
. - Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldEventScopedCustomFieldDefinitions.registrationGroups
. - Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldEventScopedCustomFieldDefinitions.registrationTypes
. - Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldEventScopedCustomFieldDefinitions.registrations
. - Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldEventScopedCustomFieldDefinitions.sessions
. - Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldEventScopedCustomFieldDefinitions.sessionRoles
. - Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldMembershipContactStoreScopedCustomFieldDefinitions.contacts
. - Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldMembershipContactStoreScopedCustomFieldDefinitions.functionGroups
. - Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldMembershipContactStoreScopedCustomFieldDefinitions.functionFeeTypes
. - Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldMembershipContactStoreScopedCustomFieldDefinitions.functions
. - Argument
input: CustomFieldDefinitionSearchFilterInput!
(with default value) added to fieldMembershipContactStoreScopedCustomFieldDefinitions.functionRegistrations
. - Input field
marketingFilter
of typeContactMarketingFilterInput
was added to input object typeCeContactStoreContactSearchFilterInput
. - Input field
marketingFilter
of typeContactMarketingFilterInput
was added to input object typeContactStoreContactSearchFilterInput
. - Input field
marketingFilter
of typeContactMarketingFilterInput
was added to input object typeContactSearchFilterInput
. - Input field
marketingFilter
of typeContactMarketingFilterInput
was added to input object typeMembershipContactStoreContactSearchFilterInput
.
✅ Non-breaking changes
- Field
marketing
was added to object typeEventSetup
. - Field
note
was added to object typeEventSetup
. - Field
marketing
was added to object typeMembershipContactStoreSetup
. - Field
membership
was added to object typeMembershipContactStoreSetup
. - Field
note
was added to object typeMembershipContactStoreSetup
. - Field
marketing
was added to object typeCeContactStoreSetup
. - Field
note
was added to object typeCeContactStoreSetup
. - Field
marketingRecords
was added to object typeCeContactStore
. - Field
notes
was added to object typeCeContactStore
. - Field
marketingRecords
was added to object typeCeContactStoreScopedCustomFieldDefinitions
. - Field
noteTypes
was added to object typeCeContactStoreScopedCustomFieldDefinitions
. - Field
notes
was added to object typeCeContactStoreScopedCustomFieldDefinitions
. - Field
inactiveSince
was added to object typeCeContactStoreContact
. - Field
isAnonymized
was added to object typeCeContactStoreContact
. - Field
marketingRecords
was added to object typeCeContactStoreContact
. - Field
notes
was added to object typeCeContactStoreContact
. - Field
marketingRecords
was added to object typeContactStore
. - Field
notes
was added to object typeContactStore
. - Field
marketingRecords
was added to object typeContactStoreScopedCustomFieldDefinitions
. - Field
noteTypes
was added to object typeContactStoreScopedCustomFieldDefinitions
. - Field
notes
was added to object typeContactStoreScopedCustomFieldDefinitions
. - Field
marketing
was added to object typeContactStoreSetup
. - Field
note
was added to object typeContactStoreSetup
. - Field
inactiveSince
was added to object typeContactStoreContact
. - Field
isAnonymized
was added to object typeContactStoreContact
. - Field
marketingRecords
was added to object typeContactStoreContact
. - Field
notes
was added to object typeContactStoreContact
. - Field
isAnonymized
was added to object typeContact
. - Field
marketingRecords
was added to object typeContact
. - Field
notes
was added to object typeContact
. - Field
marketingRecords
was added to object typeEvent
. - Field
notes
was added to object typeEvent
. - Field
marketingGroups
was added to object typeEventScopedCustomFieldDefinitions
. - Field
marketingRecords
was added to object typeEventScopedCustomFieldDefinitions
. - Field
marketingSubTags
was added to object typeEventScopedCustomFieldDefinitions
. - Field
marketingTags
was added to object typeEventScopedCustomFieldDefinitions
. - Field
noteTypes
was added to object typeEventScopedCustomFieldDefinitions
. - Field
notes
was added to object typeEventScopedCustomFieldDefinitions
. - Field
contactSnapshot
was added to object typeJournalEntry
. - Field
marketingRecords
was added to object typeMembershipContactStore
. - Field
notes
was added to object typeMembershipContactStore
. - Field
marketingRecords
was added to object typeMembershipContactStoreScopedCustomFieldDefinitions
. - Field
noteTypes
was added to object typeMembershipContactStoreScopedCustomFieldDefinitions
. - Field
notes
was added to object typeMembershipContactStoreScopedCustomFieldDefinitions
. - Field
inactiveSince
was added to object typeMembershipContactStoreContact
. - Field
isAnonymized
was added to object typeMembershipContactStoreContact
. - Field
marketingRecords
was added to object typeMembershipContactStoreContact
. - Field
membershipRegistrations
was added to object typeMembershipContactStoreContact
. - Field
notes
was added to object typeMembershipContactStoreContact
. - Field
registrationGroups
was added to object typeRegistrationSetup
. - Field
createCeContactStoreMarketingRecord
was added to object typeMutation
. - Field
createCeContactStoreNote
was added to object typeMutation
. - Field
createContactStoreMarketingRecord
was added to object typeMutation
. - Field
createContactStoreNote
was added to object typeMutation
. - Field
createEventMarketingRecord
was added to object typeMutation
. - Field
createEventNote
was added to object typeMutation
. - Field
createMembershipCategory
was added to object typeMutation
. - Field
createMembershipContactStoreMarketingRecord
was added to object typeMutation
. - Field
createMembershipContactStoreNote
was added to object typeMutation
. - Field
createMembershipFeeType
was added to object typeMutation
. - Field
createMembershipRegistration
was added to object typeMutation
. - Field
deleteCeContactStoreMarketingRecord
was added to object typeMutation
. - Field
deleteCeContactStoreNote
was added to object typeMutation
. - Field
deleteContactStoreMarketingRecord
was added to object typeMutation
. - Field
deleteContactStoreNote
was added to object typeMutation
. - Field
deleteEventMarketingRecord
was added to object typeMutation
. - Field
deleteEventNote
was added to object typeMutation
. - Field
deleteMembershipCategory
was added to object typeMutation
. - Field
deleteMembershipContactStoreMarketingRecord
was added to object typeMutation
. - Field
deleteMembershipContactStoreNote
was added to object typeMutation
. - Field
deleteMembershipFeeType
was added to object typeMutation
. - Field
deleteMembershipRegistration
was added to object typeMutation
. - Field
updateCeContactStoreMarketingRecord
was added to object typeMutation
. - Field
updateCeContactStoreNote
was added to object typeMutation
. - Field
updateContactStoreMarketingRecord
was added to object typeMutation
. - Field
updateContactStoreNote
was added to object typeMutation
. - Field
updateEventMarketingRecord
was added to object typeMutation
. - Field
updateEventNote
was added to object typeMutation
. - Field
updateMembershipCategory
was added to object typeMutation
. - Field
updateMembershipContactStoreMarketingRecord
was added to object typeMutation
. - Field
updateMembershipContactStoreNote
was added to object typeMutation
. - Field
updateMembershipFeeType
was added to object typeMutation
. - Field
updateMembershipRegistration
was added to object typeMutation
. - Type
CeContactStoreMarketingGroup
was added. - Type
CeContactStoreMarketingRecord
was added. - Type
CeContactStoreMarketingSetup
was added. - Type
CeContactStoreMarketingSubTag
was added. - Type
CeContactStoreMarketingTag
was added. - Type
CeContactStoreNote
was added. - Type
CeContactStoreNoteSetup
was added. - Type
CeContactStoreNoteType
was added. - Type
ContactMarketingFilterInput
was added. - Type
ContactStoreMarketingGroup
was added. - Type
ContactStoreMarketingRecord
was added. - Type
ContactStoreMarketingSetup
was added. - Type
ContactStoreMarketingSubTag
was added. - Type
ContactStoreMarketingTag
was added. - Type
ContactStoreNote
was added. - Type
ContactStoreNoteSetup
was added. - Type
ContactStoreNoteType
was added. - Type
CreateCeContactStoreMarketingRecordInput
was added. - Type
CreateCeContactStoreMarketingRecordPayload
was added. - Type
CreateCeContactStoreNoteInput
was added. - Type
CreateCeContactStoreNotePayload
was added. - Type
CreateContactStoreMarketingRecordInput
was added. - Type
CreateContactStoreMarketingRecordPayload
was added. - Type
CreateContactStoreNoteInput
was added. - Type
CreateContactStoreNotePayload
was added. - Type
CreateEventMarketingRecordInput
was added. - Type
CreateEventMarketingRecordPayload
was added. - Type
CreateEventNoteInput
was added. - Type
CreateEventNotePayload
was added. - Type
CreateMembershipCategoryInput
was added. - Type
CreateMembershipCategoryPayload
was added. - Type
CreateMembershipContactStoreMarketingRecordInput
was added. - Type
CreateMembershipContactStoreMarketingRecordPayload
was added. - Type
CreateMembershipContactStoreNoteInput
was added. - Type
CreateMembershipContactStoreNotePayload
was added. - Type
CreateMembershipFeeTypeInput
was added. - Type
CreateMembershipFeeTypePayload
was added. - Type
CreateMembershipRegistrationInput
was added. - Type
CreateMembershipRegistrationPayload
was added. - Type
CustomFieldDefinitionSearchFilterInput
was added. - Type
DateMarketingTagFilterInput
was added. - Type
DeleteCeContactStoreMarketingRecordInput
was added. - Type
DeleteCeContactStoreNoteInput
was added. - Type
DeleteContactStoreMarketingRecordInput
was added. - Type
DeleteContactStoreNoteInput
was added. - Type
DeleteEventMarketingRecordInput
was added. - Type
DeleteEventNoteInput
was added. - Type
DeleteMembershipCategoryInput
was added. - Type
DeleteMembershipContactStoreMarketingRecordInput
was added. - Type
DeleteMembershipContactStoreNoteInput
was added. - Type
DeleteMembershipFeeTypeInput
was added. - Type
DeleteMembershipRegistrationInput
was added. - Type
EventMarketingGroup
was added. - Type
EventMarketingRecord
was added. - Type
EventMarketingSetup
was added. - Type
EventMarketingSubTag
was added. - Type
EventMarketingTag
was added. - Type
EventNote
was added. - Type
EventNoteSetup
was added. - Type
EventNoteType
was added. - Type
JournalEntryContact
was added. - Type
MarketingSearchFilterInput
was added. - Type
MarketingTagFilterOperator
was added. - Type
MarketingTagType
was added. - Type
MembershipCategory
was added. - Type
MembershipContactStoreMarketingGroup
was added. - Type
MembershipContactStoreMarketingRecord
was added. - Type
MembershipContactStoreMarketingSetup
was added. - Type
MembershipContactStoreMarketingSubTag
was added. - Type
MembershipContactStoreMarketingTag
was added. - Type
MembershipContactStoreNote
was added. - Type
MembershipContactStoreNoteSetup
was added. - Type
MembershipContactStoreNoteType
was added. - Type
MembershipFeeType
was added. - Type
MembershipRegistration
was added. - Type
MembershipSetup
was added. - Type
NumericMarketingTagFilterInput
was added. - Type
SubTagMarketingTagFilterInput
was added. - Type
TagOnlyMarketingTagFilterInput
was added. - Type
TextMarketingTagFilterInput
was added. - Type
UpdateCeContactStoreMarketingRecordInput
was added. - Type
UpdateCeContactStoreMarketingRecordPayload
was added. - Type
UpdateCeContactStoreNoteInput
was added. - Type
UpdateCeContactStoreNotePayload
was added. - Type
UpdateContactStoreMarketingRecordInput
was added. - Type
UpdateContactStoreMarketingRecordPayload
was added. - Type
UpdateContactStoreNoteInput
was added. - Type
UpdateContactStoreNotePayload
was added. - Type
UpdateEventMarketingRecordInput
was added. - Type
UpdateEventMarketingRecordPayload
was added. - Type
UpdateEventNoteInput
was added. - Type
UpdateEventNotePayload
was added. - Type
UpdateMembershipCategoryInput
was added. - Type
UpdateMembershipCategoryPayload
was added. - Type
UpdateMembershipContactStoreMarketingRecordInput
was added. - Type
UpdateMembershipContactStoreMarketingRecordPayload
was added. - Type
UpdateMembershipContactStoreNoteInput
was added. - Type
UpdateMembershipContactStoreNotePayload
was added. - Type
UpdateMembershipFeeTypeInput
was added. - Type
UpdateMembershipFeeTypePayload
was added. - Type
UpdateMembershipRegistrationInput
was added. - Type
UpdateMembershipRegistrationPayload
was added.
2024-04-17
Bug fixes
- Fixed an issue when querying for invoices related to a contact that has been deleted.
- Fixed an issue when querying for payable items related to a contact that has been deleted.
2024-03-13
Bug fixes
- Fixed an issue where querying for presentations for a contact was not returning the expected results.
2024-02-22
Bug fixes
-
Fixed an issue where querying for an event's associated contact store could return inconsistent results. For example using a query similar to:
query Events($eventId: ID!) {
event(id: $eventId) {
associatedContactStore {
... on ContactStore {
id
}
}
}
} -
Fixed an issue where querying for inclusions for a sponsorship package could return inconsistent results. For example using a query similar to:
query Events($eventId: ID!) {
event(id: $eventId) {
sponsorships {
package {
inclusions {
id
}
}
}
}
}
2024-02-16
Bug fixes
-
Fixed an issue where querying registration types for registrations within an event could return inconsistent results. For example using a query similar to:
query Events($eventId: ID!) {
event(id: $eventId) {
registrations {
id
type {
id
name
}
}
}
}
2024-02-15
Key feature changes
The following key features have been added or modified. Please refer to the detailed GraphQL API schema changes following for further details.
- Added support for accessing and managing EventsAir contact stores. See
ContactStore
,CeContactStore
andMembershipContactStore
objects and their associated types. - Added advanced filtering to
Event.contacts
,Event.functionRegistration
andEvent.registrations
queries. For more details see the input typesContactSearchFilterInput
,FunctionRegistrationFilterInput
andRegistrationFilterInput
used in these queries. InvoiceLineItemTax
has been added to provide tax details forInvoiceLineItem
s.- Added support for showing details of
Payment
s made using EventsAir Pay. - The field
userAccessRights
on object typeEvent
has been deprecated. Please use the new fieldaccessRights
instead.userAccessRights
will be removed in a future release. - The
limit
argument used in queries type to limit the number of items returned has been changed fromPositiveInt
toPaginationLimit
. The maximum value oflimit
is now 2,000. - A search feature has been added to the developer portal to make it easier to search for documentation.
- Various objects have been renamed:
EventOffice
has been renamed toOffice
.EventTextMessagingService
has been renamed toTextMessagingService
.EventEmailMessagingService
has been renamed toEmailMessagingService
.EventOnlinePaymentServices
has been renamed toOnlinePaymentServices
.EventUserAccessRights
has been renamed toUserAccessRights
.EventInvoiceConfiguration
has been renamed toInvoiceConfiguration
.
Bug fixes
- Changed the type of
Contact.website
fromURL
toString
to cater for instances where the website field in EventsAir is not a well-formed URL.
GraphQL API schema changes
❌ Breaking changes
- Type for argument
limit
on fieldContact.exhibitionBookings
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldContact.customFields
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldContact.registrations
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldContact.functionRegistrations
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldContact.sponsorships
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldContact.presentations
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldQuery.events
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldQuery.invoices
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldQuery.journals
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldQuery.payableItems
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldQuery.payments
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldGloballyScopedCustomFieldDefinitions.events
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldCustomFieldDefinition.tags
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEventCustomFieldDefinition.tags
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldContactStoreCustomFieldDefinition.tags
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldGloballyScopedCustomFieldDefinition.tags
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEventAgenda.items
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEventAgenda.itemsByDate
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEventAgenda.itemsByTypes
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldFunctionEventAgendaItem.customFields
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldSessionEventAgendaItem.customFields
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEvent.customFields
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEvent.sponsorships
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
input
on fieldEvent.contacts
changed fromFindEventContactsInput!
toContactSearchFilterInput!
. - Type for argument
limit
on fieldEvent.contacts
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEvent.exhibitionBookings
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEvent.registrations
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEvent.sessions
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEvent.presenters
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEvent.presentations
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEvent.functionRegistrations
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEventScopedCustomFieldDefinitions.contacts
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEventScopedCustomFieldDefinitions.exhibitionBookings
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEventScopedCustomFieldDefinitions.exhibitionStandTypes
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEventScopedCustomFieldDefinitions.functionGroups
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEventScopedCustomFieldDefinitions.functionFeeTypes
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEventScopedCustomFieldDefinitions.functions
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEventScopedCustomFieldDefinitions.functionRegistrations
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEventScopedCustomFieldDefinitions.presentations
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEventScopedCustomFieldDefinitions.registrationGroups
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEventScopedCustomFieldDefinitions.registrationTypes
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEventScopedCustomFieldDefinitions.registrations
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEventScopedCustomFieldDefinitions.sessions
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldEventScopedCustomFieldDefinitions.sessionRoles
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldExhibitionSetup.stands
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldExhibitionStandType.stands
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldExhibitionStandType.customFields
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldExhibitionBooking.customFields
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldFunctionRegistration.customFields
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldFunctionSetup.functionGroups
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldFunctionSetup.functions
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldFunctionSetup.discountCodes
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldFunction.registrations
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldFunction.customFields
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldFunctionGroup.customFields
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldFunctionFeeType.customFields
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldJournal.entries
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldPresentation.customFields
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldRegistrationType.customFields
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldRegistrationType.registrations
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldRegistrationGroup.customFields
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldRegistration.customFields
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldRegistrationSetup.registrationTypes
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldRegistrationSetup.discountCodes
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldSession.customFields
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldSessionRole.customFields
changed fromPositiveInt!
toPaginationLimit!
. - Type for argument
limit
on fieldSponsorshipSetup.sponsorshipPackages
changed fromPositiveInt!
toPaginationLimit!
. - Field
Contact.website
changed type fromURL
toString
. - Field
Event.office
changed type fromEventOffice!
toOffice!
. - Field
Event.textMessagingService
changed type fromEventTextMessagingService
toTextMessagingService
. - Field
Event.emailMessagingService
changed type fromEventEmailMessagingService
toEmailMessagingService
. - Field
Event.onlinePaymentServices
changed type fromEventOnlinePaymentServices!
toOnlinePaymentServices!
. - Field
Event.userAccessRights
changed type fromEventUserAccessRights!
toUserAccessRights!
. - Field
Event.invoiceConfiguration
changed type fromEventInvoiceConfiguration
toInvoiceConfiguration
. - Input field
CreateContactInput.website
changed type fromURL
toString
. - Input field
UpdateContactDetailsInput.website
changed type fromURL
toString
. - Type
FindEventContactsInput
was removed. - Type
EventContactsWhere
was removed. - Type
EventContactsOrderBy
was removed. - Type
EventContactOrderByField
was removed. - Type
EventOffice
was removed. - Type
EventTextMessagingService
was removed. - Type
EventEmailMessagingService
was removed. - Type
EventOnlinePaymentServices
was removed. - Type
EventUserAccessRights
was removed. - Type
EventUser
was removed. - Type
EventInvoiceConfiguration
was removed.
⚠️ Dangerous changes
- Enum value
EVENTSAIR_PAYMENTS
was added to enumPaymentFundingType
. - Argument
input: RegistrationFilterInput!
(with default value) added to fieldEvent.registrations
. - Argument
input: FunctionRegistrationFilterInput!
(with default value) added to fieldEvent.functionRegistrations
. - Default value for argument
input
on fieldEvent.contacts
changed from{ orderBy: { field: 'LAST_NAME', direction: 'ASCENDING' } }
to{}
. - Member
EventsAirPaymentsPaymentDetails
was added to Union typePaymentDetails
.
✅ Non-breaking changes
- Field
associatedContactStoreContact
was added to object typeContact
. - Field
ceContactStore
was added to object typeQuery
. - Field
ceContactStores
was added to object typeQuery
. - Field
contactStore
was added to object typeQuery
. - Field
contactStores
was added to object typeQuery
. - Field
membershipContactStore
was added to object typeQuery
. - Field
membershipContactStores
was added to object typeQuery
. - Field
accessRights
was added to object typeEvent
. - Field
associatedContactStore
was added to object typeEvent
. - Field
taxes
was added to object typeInvoiceLineItem
. - Field
updateCeContactStore
was added to object typeMutation
. - Field
updateContactStore
was added to object typeMutation
. - Field
updateMembershipContactStore
was added to object typeMutation
. - Field
Event.userAccessRights
is deprecated. - Field
Event.userAccessRights
has deprecation reason: UseEvent.accessRights
instead. This field will be removed in a future release.. - Type
AccessRights
was added. - Type
AmountCustomFieldFilterInput
was added. - Type
AssociatedContactStoreContact
was added. - Type
CeContactStore
was added. - Type
CeContactStoreContact
was added. - Type
CeContactStoreContactSearchFilterInput
was added. - Type
CeContactStoreScopedCustomFieldDefinitions
was added. - Type
CeContactStoreSetup
was added. - Type
CheckboxCustomFieldFilterInput
was added. - Type
ContactDataStore
was added. - Type
ContactFilterInput
was added. - Type
ContactMarketingPrivacyStatusFilter
was added. - Type
ContactSearchFilterInput
was added. - Type
ContactStore
was added. - Type
ContactStoreContact
was added. - Type
ContactStoreContactSearchFilterInput
was added. - Type
ContactStoreOrderByField
was added. - Type
ContactStoreScopedCustomFieldDefinitions
was added. - Type
ContactStoreSetup
was added. - Type
ContactStoresOrderBy
was added. - Type
ContactStoresWhere
was added. - Type
CustomFieldFilterInput
was added. - Type
DateCustomFieldFilterInput
was added. - Type
DocumentCustomFieldFilterInput
was added. - Type
EmailMessagingService
was added. - Type
EventCheckInStatus
was added. - Type
EventsAirApiKey
was added. - Type
EventsAirIdentity
was added. - Type
EventsAirPaymentsPaymentDetails
was added. - Type
EventsAirUser
was added. - Type
FindContactStoresInput
was added. - Type
FunctionCheckInStatus
was added. - Type
FunctionCheckOutStatus
was added. - Type
FunctionRegistrationFilterInput
was added. - Type
HtmlCustomFieldFilterInput
was added. - Type
InvoiceConfiguration
was added. - Type
InvoiceLineItemTax
was added. - Type
MembershipContactStore
was added. - Type
MembershipContactStoreContact
was added. - Type
MembershipContactStoreContactSearchFilterInput
was added. - Type
MembershipContactStoreScopedCustomFieldDefinitions
was added. - Type
MembershipContactStoreSetup
was added. - Type
NumberCustomFieldFilterInput
was added. - Type
Office
was added. - Type
OnlinePaymentServices
was added. - Type
PaginationLimit
was added. - Type
RegistrationFilterInput
was added. - Type
TagCustomFieldFilterInput
was added. - Type
Tax
was added. - Type
TaxType
was added. - Type
TextCustomFieldFilterInput
was added. - Type
TextMessagingService
was added. - Type
UpdateCeContactStoreInput
was added. - Type
UpdateCeContactStorePayload
was added. - Type
UpdateContactStoreInput
was added. - Type
UpdateContactStorePayload
was added. - Type
UpdateMembershipContactStoreInput
was added. - Type
UpdateMembershipContactStorePayload
was added. - Type
UserAccessRights
was added.
2023-12-04
Key feature changes
The following key features have been added or modified. Please refer to the detailed GraphQL API schema changes following for further details.
- Added types and queries for finance related data across payable items including
Journal
s,Invoice
s,Payment
s andAccount
s. - The field
address
on input object typeUpdateContactDetailsInput
has been deprecated. Please use the new fieldprimaryAddress
instead.address
will be removed in a future release.
Bug fixes
- Changed the type of
AuthorDetails.lastName
so that it aligns withContact.lastName
. This fixes an issue when querying details for presentation authors where the union typeAuthorContact
is used.
GraphQL API schema changes
❌ Breaking changes
- Field
AuthorDetails.lastName
changed type fromString!
toString
.
⚠️ Dangerous changes
- Input field
primaryAddress
of typeAddressInput
was added to input object typeUpdateContactDetailsInput
.
✅ Non-breaking changes
- Field
invoices
was added to object typeQuery
. - Field
journals
was added to object typeQuery
. - Field
payableItems
was added to object typeQuery
. - Field
payments
was added to object typeQuery
. - Field
account
was added to object typeEventSetup
. - Type
Account
was added. - Type
AccountSetup
was added. - Type
AccountType
was added. - Type
CheckPaymentDetails
was added. - Type
CreditCardPaymentDetails
was added. - Type
DirectDepositPaymentDetails
was added. - Type
Invoice
was added. - Type
InvoiceFinancialTransactionType
was added. - Type
InvoiceLineItem
was added. - Type
InvoiceRecipient
was added. - Type
InvoiceRecipientAddress
was added. - Type
InvoiceStatus
was added. - Type
JobCode
was added. - Type
Journal
was added. - Type
JournalEntry
was added. - Type
PayPalPaymentDetails
was added. - Type
PayableItem
was added. - Type
PayableItemTarget
was added. - Type
PayableItemTargetType
was added. - Type
Payment
was added. - Type
PaymentDetails
was added. - Type
PaymentFundingType
was added. - Type
PaymentLineItem
was added. - Type
PaymentType
was added. - Type
PaymentTypeFee
was added. - Type
PaymentTypeFeeType
was added. - Type
PositiveFloat
was added.
2023-11-14
Key feature changes
The following key features have been added or modified. Please refer to the detailed GraphQL API schema changes following for further details.
- Query depth limit has been increased to
7
. - Links to interactive sites can now be retrieved for an event:
Event.links
. - You can retrieve auto-login tokens for a contact via the
Contact.onlineUser
field. - A new mutation
updateEvent
has been added. Currently, the mutation only supports creating or updating custom field values for an event. - Added new fields to
Contact
,Event
and other types. - Field
GloballyScopedCustomFieldDefinitions.events
changed type from[CustomFieldDefinition!]!
to[GloballyScopedCustomFieldDefinition!]!
.
GraphQL API schema changes
❌ Breaking changes
- Field
limit
was removed from object typeRegistrationType
. - Field
limit
was removed from object typeRegistrationGroup
. - Field
limit
was removed from object typeSponsorshipPackage
. - Field
GloballyScopedCustomFieldDefinitions.events
changed type from[CustomFieldDefinition!]!
to[GloballyScopedCustomFieldDefinition!]!
. CustomFieldDefinition
kind changed fromObjectTypeDefinition
toInterfaceTypeDefinition
.- Type
InventoryLimit
was removed.
⚠️ Dangerous changes
- Input field
inactiveSince
of typeDateTime
was added to input object typeCreateContactInput
. - Input field
userDefinedField1
of typeString
was added to input object typeCreateContactInput
. - Input field
userDefinedField2
of typeString
was added to input object typeCreateContactInput
. - Input field
userDefinedField3
of typeString
was added to input object typeCreateContactInput
. - Input field
userDefinedField4
of typeString
was added to input object typeCreateContactInput
. - Input field
inactiveSince
of typeDateTime
was added to input object typeUpdateContactDetailsInput
. - Input field
userDefinedField1
of typeString
was added to input object typeUpdateContactDetailsInput
. - Input field
userDefinedField2
of typeString
was added to input object typeUpdateContactDetailsInput
. - Input field
userDefinedField3
of typeString
was added to input object typeUpdateContactDetailsInput
. - Input field
userDefinedField4
of typeString
was added to input object typeUpdateContactDetailsInput
.
✅ Non-breaking changes
- Field
inactiveSince
was added to object typeContact
. - Field
onlineUser
was added to object typeContact
. - Field
userDefinedField1
was added to object typeContact
. - Field
userDefinedField2
was added to object typeContact
. - Field
userDefinedField3
was added to object typeContact
. - Field
userDefinedField4
was added to object typeContact
. - Field
links
was added to object typeEvent
. - Field
guests
was added to object typeFunctionRegistration
. - Field
guestType
was added to object typeFunction
. - Field
inventoryLimit
was added to object typeFunction
. - Field
inventoryLimit
was added to object typeRegistrationGroup
. - Field
createFunctionRegistrationWithBasicGuests
was added to object typeMutation
. - Field
createFunctionRegistrationWithContactGuests
was added to object typeMutation
. - Field
updateEvent
was added to object typeMutation
. - Field
updateFunctionRegistrationWithBasicGuests
was added to object typeMutation
. - Field
updateFunctionRegistrationWithContactGuests
was added to object typeMutation
. - Type
ContactStoreCustomFieldDefinition
was added. - Type
CreateBasicFunctionGuestInput
was added. - Type
CreateContactFunctionGuestInput
was added. - Type
CreateFunctionRegistrationWithBasicGuestsInput
was added. - Type
CreateFunctionRegistrationWithContactGuestsInput
was added. - Type
EventAttendance
was added. - Type
EventCustomFieldDefinition
was added. - Type
FunctionGuest
was added. - Type
FunctionGuestContact
was added. - Type
FunctionGuestDetails
was added. - Type
FunctionGuestType
was added. - Type
GloballyScopedCustomFieldDefinition
was added. - Type
Link
was added. - Type
LinkType
was added. - Type
OnlineUser
was added. - Type
OpenEndedDateTimeRangeFilter
was added. - Type
OpenEndedLocalDateRangeFilter
was added. - Type
StringRangeFilterInput
was added. - Type
UpdateBasicFunctionGuestInput
was added. - Type
UpdateContactFunctionGuestInput
was added. - Type
UpdateEventInput
was added. - Type
UpdateEventPayload
was added. - Type
UpdateFunctionRegistrationWithBasicGuestsInput
was added. - Type
UpdateFunctionRegistrationWithContactGuestsInput
was added.
2023-09-27
Bug fixes
- Fixed a bug in
Mutation.createContact
where setting primary address details caused a server error.
2023-08-02
- Initial release for early access program.