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 behaviour 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-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.