Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from a Beekeeper source in Nexla.
beekeeper_api.png

Beekeeper

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 Beekeeper connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Beekeeper instance, and click Next; or, create a new Beekeeper credential for use in this flow.

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

    Beekeeper sources can also be configured manually, allowing you to ingest data from Beekeeper 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 Beekeeper endpoints. Each template is designed specifically for the corresponding Beekeeper 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.

    Profiles

    This endpoint retrieves a list of user profiles from your Beekeeper account. Use this endpoint when you need to access user information, employee data, or profile details for analysis, reporting, or integration with other systems.

    • This endpoint automatically retrieves all profiles. No additional configuration is required beyond selecting this endpoint template.
    • The endpoint uses GET requests to the Beekeeper Profiles API endpoint (https://developers.beekeeper.io/profiles). The endpoint URL is automatically constructed based on the Beekeeper API base URL.
    • The endpoint will return all user profiles in your Beekeeper account. The response data is returned at the root level of the JSON response ($), containing profile information, user details, and other profile-related data.
    • The endpoint does not use pagination and returns all profiles in a single request.

    This endpoint retrieves all user profiles in a single request. The endpoint does not use pagination and returns all available profile information. The endpoint requires API key authentication with Token prefix, which is handled automatically by your credential configuration. The Authorization: Token {token} header is automatically included in requests. For detailed information about the Profiles API, including available fields and response formats, see the Beekeeper API documentation.

    Conversations

    This endpoint retrieves a list of conversations from your Beekeeper account. Use this endpoint when you need to access conversation data, messages, or communication threads for analysis, reporting, or integration with other systems.

    • This endpoint automatically retrieves all conversations. No additional configuration is required beyond selecting this endpoint template.
    • The endpoint uses GET requests to the Beekeeper Conversations API endpoint (https://developers.beekeeper.io/conversations). The endpoint URL is automatically constructed based on the Beekeeper API base URL.
    • The endpoint will return all conversations in your Beekeeper account. The response data is returned at the root level of the JSON response ($), containing conversation information, message data, and other conversation-related details.
    • The endpoint does not use pagination and returns all conversations in a single request.

    This endpoint retrieves all conversations in a single request. The endpoint does not use pagination and returns all available conversation information. The endpoint requires API key authentication with Token prefix, which is handled automatically by your credential configuration. The Authorization: Token {token} header is automatically included in requests. For detailed information about the Conversations API, including available fields and response formats, see the Beekeeper API documentation.

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​

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

With manual configuration, you can also create more complex Beekeeper sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom authentication headers or request parameters.

API Method​

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

  2. Select the API method that will be used for calls to the Beekeeper API from the Method pulldown menu. The Beekeeper API primarily uses GET requests for data retrieval operations. The most common methods are:

    • GET: For retrieving data from the API (most common for Beekeeper)
    • POST: For creating resources or triggering actions
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

API Endpoint URL​

  1. Enter the URL of the Beekeeper API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Beekeeper API endpoints typically follow the pattern https://developers.beekeeper.io/{api_path} where {api_path} is the specific API path (e.g., /profiles, /conversations).

Ensure the API endpoint URL is correct and accessible with your current credentials. The Beekeeper API base URL is https://developers.beekeeper.io. You can test the endpoint using the Test button after configuring the URL. Beekeeper API requests require API key authentication with Token prefix, and the Authorization: Token {token} header is automatically included in requests using your credential configuration. For detailed information about Beekeeper API endpoints and available APIs, see the Beekeeper API documentation.

Path to Data​

Optional

If only a subset of the data that will be returned by 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.

For example, when a request call is used to fetch a list of items, the API will typically return an array of records, along with metadata, in the response. By entering the path to the relevant data, you can configure Nexla to treat each element of the returned array as a 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., $.profiles[*] to access an array of profiles within a response object).

    • For responses in XML format, enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g., /response/data/item to access item elements within a data element).

    Path to Data Example:

    If the API response is in JSON format and includes a top-level object with an array named profiles that contains the relevant data, the path to the response would be entered as $.profiles[*].

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 example, when a request call is used to fetch a list of items, the API response will typically include an array of records along with metadata such as total count, pagination information, or request timestamps. In this case, if you have specified the path to the relevant data but metadata of interest is located in a different part of the response, you can specify a path to this metadata to include it with each record in the generated Nexset(s).

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, and for responses in XML format, enter the XPath.

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). Additional headers are often required for API versioning, content type specifications, or custom authentication requirements.

    You do not need to include any headers already present in the credentials. Common headers like Authorization, Content-Type, and Accept are typically handled automatically by Nexla based on your credential configuration. Beekeeper API requests require API key authentication with Token prefix, and the Authorization: Token {token} header is automatically included in requests using your credential configuration.

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