Skip to main content

Beekeeper Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a sync or streaming data flow that sends data to a Beekeeper location.
beekeeper_api.png

Beekeeper

Create a Beekeeper Destination​

  1. Click the + icon on the Nexset that will be sent to the Beekeeper destination, and select the Send to Destination option from the menu.

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

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

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

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Beekeeper endpoints. Each template is designed specifically for the corresponding Beekeeper endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, 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.

Configure Manually​

Beekeeper destinations can be manually configured to send data to 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.

API Method​

  1. To manually configure this destination, 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 POST requests for data writing operations. The most common methods are:

    • POST: For creating new resources (e.g., creating conversations, posts)
    • 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 to which this destination will send 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., /conversations, /posts).

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.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, 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. The Content-Type: application/json header is typically set automatically for JSON request bodies.

Request Body​

Optional

  • If the API endpoint requires a specific request body format, configure how Nexla should format the request body from your Nexset data. The request body can be sent as JSON, XML, or form data, depending on the API endpoint requirements.

    • For JSON format, select JSON from the Request Body Format dropdown, and the Nexset data will be sent as a JSON object in the request body. Beekeeper API endpoints typically use JSON format for request bodies.

    • For XML format, select XML from the Request Body Format dropdown, and the Nexset data will be converted to XML format in the request body.

    • For Form data format, select Form Data from the Request Body Format dropdown, and the Nexset data will be sent as form-encoded data in the request body.

The request body format should match the requirements of the specific Beekeeper API endpoint you're using. Most Beekeeper API endpoints use JSON format for request bodies. Ensure your Nexset data structure matches the expected format for the API endpoint, including required fields, data types, and nested structures as specified in the Beekeeper API documentation.

Save & Activate the Destination​

  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 destination. Nexla will now begin sending data from the selected Nexset to the configured endpoint.