Cube Software API Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a Cube Software API location.

Cube Software API

Create a Cube Software API Destination

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

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

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

   Cube Software API destinations can also be configured manually, allowing you to send data to Cube Software API 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 Cube Software API endpoints. Each template is designed specifically for the corresponding Cube Software API 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.

  Create an action item

  This endpoint creates a new action item in Cube Software with the details provided in the Nexset data. Action items in Cube Software are trackable tasks or follow-up items tied to planning workflows. Use this endpoint to programmatically create action items from external data sources — for example, to import tasks from a project management tool into Cube Software.

  • Map your Nexset fields to the action item fields required by Cube Software. The request body is sent as a JSON payload ({message.json}), so ensure your Nexset schema includes the fields expected by the Cube Software action items API.
  • This endpoint sends a POST request to https://api.cubesoftware.com/action-items. Each record in your Nexset will result in one API call to create one action item.

  For the full list of fields accepted when creating an action item, refer to the Cube API Action Items documentation.

  Update an action item

  This endpoint partially updates an existing action item in Cube Software by its unique ID. Use this endpoint to update the status, assignee, due date, or other properties of an action item from an external system or data flow.

  • Enter the unique identifier of the action item to update in the Action Item ID field. This value is appended to the API endpoint URL and identifies which action item will be modified.

  • Map your Nexset fields to the action item fields you want to update. Only the fields included in the payload will be modified; other fields will remain unchanged (PATCH semantics).

  For the full list of updatable fields, refer to the Cube API Action Items documentation.

  Create Chat Message

  This endpoint creates a new chat message within a Cube Software agent chat session. Use this endpoint to programmatically send messages to a Cube AI agent session — for example, to trigger automated queries or deliver structured data as part of an agent interaction workflow.

  • Map your Nexset fields to the chat message fields required by Cube Software. The request body is sent as a JSON payload. Ensure your Nexset includes the fields expected by the Cube Software agent chat messages API, such as the session ID and message content.
  • This endpoint sends a POST request to https://api.cubesoftware.com/agents/chat/messages.

  For the full list of fields accepted when creating a chat message, refer to the Cube API Chat Messages documentation.

  Create Chat Session

  This endpoint creates a new chat session for a Cube Software agent interaction. Use this endpoint to programmatically initiate AI agent sessions — for example, to automate the creation of planning-related agent conversations as part of a data pipeline.

  • Map your Nexset fields to the chat session fields required by Cube Software. The request body is sent as a JSON payload. Ensure your Nexset includes the fields expected by the Cube Software agent chat sessions API.
  • This endpoint sends a POST request to https://api.cubesoftware.com/agents/chat/sessions.

  For the full list of fields accepted when creating a chat session, refer to the Cube API Chat Sessions documentation.

  Create a new canvas

  This endpoint creates a new canvas in Cube Software with the specified configuration and properties. Canvases are flexible workspaces for financial reporting and planning dashboards. Use this endpoint to programmatically provision canvases — for example, to create standardized reporting views for multiple business units from a template.

  • Map your Nexset fields to the canvas fields required by Cube Software. The request body is sent as a JSON payload. Ensure your Nexset includes the canvas name, configuration, and any other required properties as defined in the Cube Software API.
  • This endpoint sends a POST request to https://api.cubesoftware.com/canvases.

  For the full list of fields accepted when creating a canvas, refer to the Cube API Canvases documentation.

  Create a cube

  This endpoint creates a new cube in Cube Software with the specified matrix, message, metadata, and other properties. A cube is a structured data model that organizes financial and operational data for planning and analysis. Use this endpoint to programmatically create cubes as part of an automated data pipeline.

  • Map your Nexset fields to the cube fields required by Cube Software. The request body is sent as a JSON payload. Ensure your Nexset includes the matrix configuration, metadata, and any other required properties as defined in the Cube Software API.
  • This endpoint sends a POST request to https://api.cubesoftware.com/cube.

  Update a data table

  This endpoint updates an existing Cube Software data table with new configuration, mappings, and settings. Use this endpoint to refresh or reconfigure a data table's structure as part of an automated pipeline — for example, to update table schemas when source data structures change.

  • Enter the unique identifier of the data table to update in the Data Table ID field. This value is appended to the API endpoint URL and identifies which data table will be modified.

  • Map your Nexset fields to the data table fields required by Cube Software. The request body is sent as a JSON payload.

  Partially update a data table

  This endpoint performs a partial update on an existing Cube Software data table configuration using PATCH semantics. Only the fields included in the payload will be modified; all other fields will remain unchanged. Use this endpoint when you need to update specific data table properties without replacing the entire configuration.

  • Enter the unique identifier of the data table to partially update in the Data Table ID field. This value is appended to the API endpoint URL.

  • Map the specific Nexset fields you want to update to the corresponding data table fields in Cube Software.

  Create a dimension

  This endpoint creates a new dimension in Cube Software with the specified name, parent, and protection settings. Dimensions are hierarchical classification structures — such as departments, cost centers, or product lines — that organize planning data. Use this endpoint to programmatically provision dimension structures as part of a data integration pipeline.

  • Map your Nexset fields to the dimension fields required by Cube Software. The request body is sent as a JSON payload. Ensure your Nexset includes the dimension name and any required hierarchy or protection settings.
  • This endpoint sends a POST request to https://api.cubesoftware.com/dimensions.

  Update Dimension

  This endpoint updates a dimension in Cube Software by its unique ID with properties such as name, type, formula, and metadata. Use this endpoint to modify dimension configurations as part of an automated data pipeline — for example, to synchronize dimension hierarchies with changes made in a master data management system.

  • Enter the unique identifier of the dimension to update in the Dimension ID field. This value is appended to the API endpoint URL.

  • Map your Nexset fields to the dimension properties you want to update, including name, type, formula, and metadata fields as required.

  Create Planning Table

  This endpoint creates a new planning table in Cube Software with the specified schema and configuration. Planning tables are structured grids used to enter, store, and analyze financial and operational planning data. Use this endpoint to programmatically provision planning tables — for example, to create standardized budget templates for multiple business units.

  • Map your Nexset fields to the planning table fields required by Cube Software. The request body is sent as a JSON payload. Ensure your Nexset includes the table schema, configuration, and any other required properties.
  • This endpoint sends a POST request to https://api.cubesoftware.com/tables.

  Upsert Planning Table Data

  This endpoint creates or replaces planning table data and configuration using PUT semantics. Use this endpoint to fully replace the contents and configuration of a planning table with new data — for example, to sync financial data from an external source into a Cube Software planning table on a scheduled basis.

  • Enter the unique identifier of the planning table in the Table ID field. This value is appended to the API endpoint URL.

  • Map your Nexset fields to the planning table fields required by Cube Software. The full dataset will replace the existing table contents.

  :::warning Important This endpoint uses PUT semantics, which replaces the entire planning table data. Ensure your Nexset contains the complete dataset you want to persist in the table before activating this destination. :::

  Update Planning Table

  This endpoint partially updates planning table properties and metadata in Cube Software using PATCH semantics. Use this endpoint to update specific table properties — such as the table name, description, or metadata — without replacing the full table configuration.

  • Enter the unique identifier of the planning table to update in the Table ID field. This value is appended to the API endpoint URL.

  • Map the specific Nexset fields you want to update to the corresponding planning table properties in Cube Software.

  Create or Update Table Dataset

  This endpoint creates or replaces dataset records for a specific planning table using PUT semantics. Use this endpoint to load or refresh the actual data rows within a planning table — for example, to synchronize actuals or forecasts from a data warehouse into Cube Software on a regular schedule.

  • Enter the unique identifier of the planning table whose dataset you want to create or replace in the Table ID field. This value is appended to the API endpoint URL.

  • Map your Nexset fields to the dataset record fields required by Cube Software. The full dataset will be created or replaced in the specified planning table.

  :::warning Important This endpoint uses PUT semantics, which replaces the existing dataset records. Ensure your Nexset contains the complete dataset you want to load before activating this destination. :::

  Create Task

  This endpoint creates a new workflow task in Cube Software with assignments, due dates, and metadata. Workflow tasks represent items in Cube's structured planning workflows. Use this endpoint to programmatically create tasks — for example, to import tasks from an external project management or ticketing system into Cube Software.

  • Map your Nexset fields to the task fields required by Cube Software. The request body is sent as a JSON payload. Ensure your Nexset includes the task name, assignee, due date, process ID, and any other required properties.
  • This endpoint sends a POST request to https://api.cubesoftware.com/tasks.

  For the full list of fields accepted when creating a task, refer to the Cube API documentation.

  Create a template

  This endpoint creates a new template in Cube Software with the specified properties, including content, styles, and sharing options. Templates in Cube Software provide reusable layouts and configurations for planning views and reports. Use this endpoint to programmatically create or publish templates as part of a content management workflow.

  • Map your Nexset fields to the template fields required by Cube Software. The request body is sent as a JSON payload. Ensure your Nexset includes the template name, content, styles, and any sharing configuration.
  • This endpoint sends a POST request to https://api.cubesoftware.com/templates.

  For the full list of fields accepted when creating a template, refer to the Cube API Templates documentation.

Configure Manually

Cube Software API destinations can be manually configured to send data to any valid Cube Software API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Cube Software API after each call to a new Nexla webhook data source.

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 Cube Software API from the Method pulldown menu. Common methods for destination configuration include:

   • POST: For creating new records (action items, cubes, canvases, tasks, templates)
   • PUT: For fully replacing existing records (planning table data, datasets)
   • PATCH: For partially updating existing records (action items, data tables, planning tables, dimensions)

Data Format

3. Select the format in which the Nexset data will be sent to the Cube Software API from the Content Format pulldown menu. The Cube Software API accepts data in JSON format. Nexla will automatically convert the data to the selected format for each API call.

API Endpoint URL

4. Enter the URL of the Cube Software API endpoint to which you want to send the Nexset data in the URL field. Use https://api.cubesoftware.com as the base URL, followed by the resource path. For update or upsert operations, append the ID of the object to be modified at the end of the URL — for example, https://api.cubesoftware.com/tables/your_table_id.

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

  You do not need to include any headers already present in the credentials, such as the OAuth 2.0 Authorization header — that is handled automatically by Nexla.

Exclude Attributes from the Call

Optional

• If any record attributes in the Nexset should be omitted when sending data to this Cube Software API destination, select the attributes from the Exclude Attributes pulldown menu.

• Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching

Optional

1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

Response Webhook

Optional

Nexla can automatically send the response received from the Cube Software API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call — for example, the IDs of newly created records returned by Cube Software.

• To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload

Sample request payloads containing a portion of the Nexset data that will be sent to the Cube Software API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

• Click on a sample request payload to expand it and view the complete payload content.
• Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)

After all endpoint settings have been configured, Nexla can send a test payload to the Cube Software API to ensure that the destination is configured correctly.

1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Cube Software API using the current settings.

Save & Activate the Destination

• 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 begin sending data to the configured Cube Software API endpoint, open the destination resource menu, and select Activate.

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