Beekeeper

Beekeeper is a frontline workforce engagement platform that connects and engages entire workforces through mobile-first communication tools, helping business leaders improve productivity and employee satisfaction across distributed teams.

Power end-to-end data operations for your Beekeeper API with Nexla. Our bi-directional Beekeeper connector is purpose-built for Beekeeper, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Beekeeper or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Beekeeper workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Beekeeper credential in Nexla, you need to obtain an API access token from your Beekeeper account. Beekeeper uses API key authentication with token-based access for secure API access. The access token provides secure, programmatic access to your Beekeeper account data through the API.

1. Access Beekeeper Developer Portal: Sign in to your Beekeeper account and navigate to the Beekeeper Developer Portal or access API settings through your Beekeeper account administration.

2. Create or View API Access Token: Create a new API access token or view an existing one in your Beekeeper account settings. API access tokens are used to authenticate requests to the Beekeeper API.

3. Review API Permissions: Ensure your API access token has the necessary permissions to access the data and perform the actions you need. Different tokens may have different scopes and permissions.

4. Copy Access Token: Copy your API access token immediately after viewing it. Keep the token secure, as it provides access to your Beekeeper account data.

   Beekeeper API access tokens provide programmatic access to your Beekeeper account. Keep your access token secure and do not share it publicly or commit it to version control systems. The access token is sent in the Authorization: Token {token} header for all API requests. If you suspect your access token has been compromised, regenerate it immediately in your Beekeeper account settings. For detailed information about obtaining an access token, see the Beekeeper API documentation.

For additional information about Beekeeper API authentication and credential management, see the Beekeeper API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
API Key Value	Yes	Yes

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Beekeeper

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your Beekeeper API access token in the API Key Value field. This should be the access token obtained from your Beekeeper account. The access token is used to authenticate requests to the Beekeeper API.

   The API access token provides secure access to your Beekeeper account data through the API. The access token is sent in the Authorization: Token {token} header for all API requests. Keep your access token secure and do not share it publicly or commit it to version control systems. For detailed information about Beekeeper API authentication, see the Beekeeper API documentation.

4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Beekeeper connector tile, 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.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Beekeeper endpoints. 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.

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.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Beekeeper data sources can also be manually configured to ingest data from any valid Beekeeper API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

The Beekeeper API base URL is https://developers.beekeeper.io, and endpoints follow the pattern https://developers.beekeeper.io/{api_path} (for example, /profiles or /conversations). API key authentication with the Authorization: Token {token} header is applied automatically from your credential configuration. If a response nests the relevant records inside an object, enter the corresponding JSON path (for example, $.profiles[*]) in the Set Path to Data in Response field. For a complete list of available endpoints, see the Beekeeper API documentation.

Once all of the relevant settings have been configured, 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.

Use as a destination

Click the + icon on the Nexset that will be sent to the Beekeeper destination, and select the Send to Destination option from the menu. Select the Beekeeper connector from the list of available destination connectors, then select the credential that will be used to connect to the Beekeeper organization, and click Next; or, create a new Beekeeper credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Beekeeper endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Start conversation

This endpoint creates a new conversation in your Beekeeper account. Use this endpoint when you need to start conversations, send messages, or initiate communication threads from your data sources.

• This endpoint uses POST 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 sends data from your Nexset as the request body in JSON format. Each record in your Nexset will be sent as a JSON object containing the conversation data to create. The request body should follow the Beekeeper API specification for starting conversations, including required fields such as participants, message content, and other conversation settings.
• Ensure your Nexset data includes the required fields for conversation creation, such as participant IDs, message content, and other required fields based on the Beekeeper API specification. The JSON request body should match the expected format for creating conversations.
• Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to create a conversation. If you need to start multiple conversations, you can send multiple records, but each will be processed as a separate request.

The request body must be properly formatted JSON that matches the Beekeeper API specification for starting conversations. 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. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about starting conversations, including required fields, request formats, and response structures, see the Beekeeper API documentation.

Create Post

This endpoint creates a new post in your Beekeeper account. Use this endpoint when you need to publish posts, announcements, or content from your data sources to your Beekeeper platform.

• This endpoint uses POST requests to the Beekeeper Posts API endpoint (https://developers.beekeeper.io/posts). The endpoint URL is automatically constructed based on the Beekeeper API base URL.
• The endpoint sends data from your Nexset as the request body in JSON format. Each record in your Nexset will be sent as a JSON object containing the post data to create. The request body should follow the Beekeeper API specification for creating posts, including required fields such as post content, author information, and other post settings.
• Ensure your Nexset data includes the required fields for post creation, such as post content, author ID, and other required fields based on the Beekeeper API specification. The JSON request body should match the expected format for creating posts.
• Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to create a post. If you need to create multiple posts, you can send multiple records, but each will be processed as a separate request.

The request body must be properly formatted JSON that matches the Beekeeper API specification for creating posts. 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. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about creating posts, including required fields, request formats, and response structures, see the Beekeeper API documentation.

Manual configuration

Beekeeper destinations can also be manually configured to send data to any valid Beekeeper API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

The Beekeeper API base URL is https://developers.beekeeper.io, and endpoints follow the pattern https://developers.beekeeper.io/{api_path} (for example, /conversations or /posts). Beekeeper API endpoints typically expect JSON request bodies. API key authentication with the Authorization: Token {token} header and the Content-Type: application/json header are applied automatically from your credential configuration.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Beekeeper endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Beekeeper endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.