Skip to main content

Humanitix Data Source

The Humanitix connector enables you to ingest event, order, ticket, and tag data from your Humanitix account into Nexla for downstream analytics, reporting, and data management workflows. Follow the instructions below to create a new data flow that ingests data from a Humanitix source in Nexla.
humanitix_api.png

Humanitix

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Humanitix connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Humanitix account, and click Next; or, create a new Humanitix credential for use in this flow.

  3. In Nexla, Humanitix data sources can be created using pre-built endpoint templates, which expedite source setup for common Humanitix API endpoints. Each template is designed specifically for the corresponding Humanitix endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Humanitix sources can also be configured manually, allowing you to ingest data from Humanitix endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Humanitix API endpoints. Each template is designed specifically for the corresponding Humanitix endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

Get Events

Retrieves a paginated list of all events owned by or shared with your Humanitix account. Use this endpoint to ingest event metadata — including event names, dates, venues, ticket types, and status — for reporting, analytics, or downstream processing.

  • This endpoint returns all events accessible to your account. No additional parameters are required beyond selecting the template — Nexla will automatically paginate through all available results.
  • The response includes an array of event objects along with pagination fields (total, page, pageSize). Nexla processes the pagination automatically to retrieve the complete event list.

The Humanitix API returns up to 100 events per page (the maximum pageSize). Nexla handles multi-page retrieval automatically when you use this template. For the complete list of fields returned per event, refer to the Humanitix API reference.

Get Orders for Event

Retrieves a paginated list of all orders for a specific event. Use this endpoint to analyze ticket sales, track order statuses, or export attendee purchase records for a given event.

  • Enter the ID of the event whose orders you want to retrieve in the Event ID field. You can find event IDs by first running the Get Events endpoint to retrieve a list of your events and their corresponding IDs.

  • The endpoint supports optional date range filtering. To limit results to orders created within a specific period, enter the start and end dates in the appropriate filter fields. Dates should be provided in ISO 8601 format (e.g., 2024-01-01T00:00:00Z).
  • The response includes an array of order objects along with pagination fields. Nexla automatically retrieves all pages of results.

Orders contain purchase details such as buyer name, email, order total, and line items. If you need to retrieve individual ticket information rather than order-level data, use the Get Tickets for Event endpoint instead.

Get Tickets for Event

Retrieves a paginated list of all tickets issued for a specific event. Use this endpoint to track individual ticket holders, check-in status, and ticket type details for attendee management or reporting purposes.

  • Enter the ID of the event whose tickets you want to retrieve in the Event ID field. Event IDs can be obtained from the Get Events endpoint.

  • The endpoint supports optional filtering by date range and ticket status. Use date filters to narrow results to tickets issued within a specific period. Use the status filter to retrieve only tickets with a particular status (e.g., active, voided, or transferred).
  • The response includes an array of ticket objects along with pagination fields. Nexla automatically paginates through all results.

Ticket records contain individual attendee-level details, including the ticket holder's name, email, ticket type, and check-in status. This endpoint is particularly useful for post-event analysis and attendee reconciliation.

Get Tags

Retrieves a paginated list of all tags defined in your Humanitix account. Tags in Humanitix are labels that can be applied to events for organization and categorization. Use this endpoint to ingest your tag library for use in reporting or to cross-reference tagged events.

  • This endpoint retrieves all tags in your account without requiring any additional parameters. Nexla automatically paginates through all available tags.
  • Each tag record includes the tag ID and name. Tag IDs can be used to filter or join with event records that reference those tags.

Tags are created and managed in the Humanitix event management console. For more information on creating tags, refer to the Humanitix Help Centre.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Humanitix data sources can be manually configured to ingest data from any valid Humanitix API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

The Humanitix REST API base URL is https://api.humanitix.com/v1. All endpoints use the GET method and require the x-api-key authentication header, which Nexla populates automatically from your configured credential.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select GET from the Method pulldown menu. The Humanitix Public API is a read-only API, and all endpoints use the HTTP GET method.

API Endpoint URL​

  1. Enter the URL of the Humanitix API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the base URL https://api.humanitix.com/v1 and any required path parameters.

    Common Humanitix endpoint URL patterns include:

    • List all events: https://api.humanitix.com/v1/events
    • Get a single event: https://api.humanitix.com/v1/events/{'{eventId}'}
    • List orders for an event: https://api.humanitix.com/v1/events/{'{eventId}'}/orders
    • Get a single order: https://api.humanitix.com/v1/events/{'{eventId}'}/orders/{'{orderId}'}
    • List tickets for an event: https://api.humanitix.com/v1/events/{'{eventId}'}/tickets
    • Get a single ticket: https://api.humanitix.com/v1/events/{'{eventId}'}/tickets/{'{ticketId}'}
    • List all tags: https://api.humanitix.com/v1/tags
    • Get a single tag: https://api.humanitix.com/v1/tags/{'{tagId}'}

Replace path parameters such as {'{eventId}'}, {'{orderId}'}, {'{ticketId}'}, and {'{tagId}'} with the actual IDs from your Humanitix account. Event IDs can be retrieved using the Get Events endpoint. Additional endpoint details are available in the Humanitix API reference on Stoplight.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements. This is useful for Humanitix endpoints that accept date-based query parameters such as startDate or endDate for filtering orders and tickets by creation date.

Macros are particularly useful for APIs that require date ranges, pagination parameters, or other dynamic values that change between data ingestion runs.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are useful when you need to create API endpoints that reference specific IDs, values, or parameters from other data sources in your Nexla environment. For example, you could use a lookup to dynamically supply event IDs from a list of events retrieved by an earlier source.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data that will be returned by the API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful when API responses contain metadata, pagination information, or other data that you don't need for your analysis.

The Humanitix API returns list responses in JSON format with a top-level object containing pagination fields (total, page, pageSize) and a data array (e.g., events, orders, tickets, or tags) containing the actual records. Setting the path to data allows Nexla to treat each element in the array as an individual record.

Path to Data is essential when API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format, enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.data.items[*] to access an array of items within a data object).
    Path to Data Example:

    For the Humanitix Get Events endpoint, the response includes a top-level array named events that contains the event records. Enter the path as $.events[*] to treat each event as a separate record. Similarly, use $.orders[*] for orders, $.tickets[*] for tickets, and $.tags[*] for tags.

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but isn't part of the main data array.

For Humanitix API responses, pagination fields (total, page, pageSize) are returned alongside the data array. If you have specified a path to the records array (e.g., $.events[*]), these pagination fields will be outside the data path. You can capture them as metadata if needed for auditing or processing logic.

Metadata paths are particularly useful for preserving API response context like request IDs, timestamps, or summary statistics that apply to all records in the response.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). The Humanitix API may require specific headers for API versioning or content type in some use cases.

    You do not need to include the x-api-key authentication header here, as it is automatically added by Nexla from your configured Humanitix credential.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Humanitix data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.