DOCSEARCHbyAlgolia
Submit Docs

EventsAir Developer Documentation

website·Indexed 43 days ago

https://developer.eventsair.com/docs/

API reference and technical documentation for EventsAir, featuring a GraphQL schema with detailed definitions for scalars, interfaces, and unions related to event management, registration, contact stores, and payment details.

Tokens
125.3K
Snippets
822
Records
1.1K
Agent score
48%

What's inside EventsAir

  1. Overview of uploading presentation documents

    To upload presentation documents via the GraphQL API, you must follow a two-step process: first, upload the file through a dedicated endpoint to receive a temporary file identifier, and then use that identifier within a GraphQL mutation (createPresentation or updatePresentation). Currently, only documents of type IMAGE, PDF, or UPLOADED_DOCUMENT are supported.

  2. Use the AttachedDocument interface for presentation attachments

    The AttachedDocument interface defines a document attached to a Presentation, ExhibitionBooking, or Sponsorship. It provides metadata about the document's lifecycle, ownership, and classification.
    interface AttachedDocument {
  createdAt: DateTime!
  createdBy: String
  dateReceived: DateTime
  id: ID!
  lastModifiedAt: DateTime!
  lastModifiedBy: String
  notes: String
  type: DocumentType!
}

  3. Understand Custom Field Definitions and Scopes

    Custom field definitions act as templates for additional values added to object types (e.g., Event, Contact). A definition specifies the target type, name, data type, an optional unique code, whether the value is required, and if it contains personal data.

    Scopes:

    • Global Scope: Event custom field definitions are global across the system. Other types like suppliers, offices, and users also have global definitions, though the GraphQL API currently only exposes those for events.
    • Event Scope: Most other types (e.g., contacts, registrations) have definitions scoped at the event level, meaning different events can have different custom field definitions for the same object type.

  4. Query deleted records in EventsAir GraphQL API

    The Query.deletedRecords field allows developers to retrieve information about deleted records. It accepts the following arguments:

    • eventIds: [ID!]!: A required list of event IDs (includes a default value).
    • sinceCursor: String: An optional cursor to fetch deletions occurring after a specific point.

    The query returns a DeletedRecordResult object containing:

    • entities: A DeletedRecordEntities object containing lists of deleted items categorized by type (e.g., contacts, registrations, sessions, invoices, etc.).
    • currentCursor: The cursor for the current set of results.
    • fullReloadRequired: A boolean indicating if a full data reload is necessary.
    query {
  deletedRecords(eventIds: ["event-123"], sinceCursor: "cursor-string") {
    currentCursor
    fullReloadRequired
    entities {
      contacts
      registrations
      sessions
      # ... other entity types
    }
  }
}

  6. Retrieve a specific webhook event type by name

    Use the webhookEventType query to fetch details about a specific webhook event type. You must provide the name of the event type as a non-null String. If no event type is found matching the provided name, the API will throw an error with the code NOT_FOUND.
    webhookEventType(
  name: String!
): WebhookEventType!

  8. Support for Split Charge Payments in EventsAir

    The platform now supports split charge payments across the following entities: registrations, hotel bookings, exhibition bookings, function registrations, travel bookings, and sponsorships.

  9. Use the PaymentDetails union type for payment methods

    The PaymentDetails union type is used to provide specific details about a payment based on the payment method used. It is a member of the Payment object. Depending on the payment source, PaymentDetails can be one of the following types:

    • CheckPaymentDetails: Details for payments made by check.
    • CreditCardPaymentDetails: Details for payments made via credit card.
    • DirectDepositPaymentDetails: Details for payments made via direct deposit.
    • EventsAirPaymentsPaymentDetails: Details for payments made using EventsAir Payments.
    • PayPalPaymentDetails: Details for payments made via PayPal.
    union PaymentDetails = CheckPaymentDetails | CreditCardPaymentDetails | DirectDepositPaymentDetails | EventsAirPaymentsPaymentDetails | PayPalPaymentDetails

  10. Track deleted records in EventsAir GraphQL API

    The EventsAir GraphQL API provides a set of types to track and retrieve information about deleted records. A DeletedRecord provides the ID of the deleted record rather than its full contents. DeletedRecordSet contains all deletions found for a specific record type; these sets are unbounded and do not use pagination or truncation signals. Note that each record type selected in an operation incurs a flat cost of 500 points, regardless of the number of deletions found.
    # Key types for tracking deletions:
# DeletedRecord: Represents a single deleted record (ID only).
# DeletedRecordEntities: A set of deletions grouped by record type.
# DeletedRecordResult: The result of a deletion operation, including found deletions and a cursor for the next operation.
# DeletedRecordSet: An unbounded set of deletions for one record type.
# DeletedRecordType: The available record types that can be reported for deletions.