Skip to main content

OfficeSpace Software 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 an OfficeSpace Software location.
officespace_api.png

OfficeSpace Software

Create an OfficeSpace Software Destination​

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

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

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

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

    Upsert Employees (Batch)

    Batch create or update employee records in OfficeSpace from an external HRIS or enriched data pipeline source. Use this endpoint to synchronize your organization's employee directory with OfficeSpace — for example, to push new hires, update profile fields, or reflect organizational changes from an upstream HR system such as Workday, BambooHR, or ADP.

    • This endpoint requires no additional configuration parameters beyond the credential selection. Nexla will POST the Nexset data as a JSON payload to the OfficeSpace batch import API endpoint at https://{hostname}.officespacesoftware.com/api/1/employee_batch_imports.

    • Each record in the Nexset should correspond to one employee and should include the fields required by OfficeSpace's batch import API. Common fields include:

      • name — The employee's full name.
      • email — The employee's email address, used as a unique identifier for upsert operations.
      • department — The employee's department or team.
      • title — The employee's job title.
    • OfficeSpace will create new employee records for employees that do not yet exist in the directory and update existing records for employees that are matched by email address.

    After using the Upsert Employees (Batch) endpoint to stage employee records, use the Trigger Employee Directory Import destination in a subsequent flow step to migrate the staged records into the live OfficeSpace employee directory. For additional information about the OfficeSpace batch import process, refer to the OfficeSpace API documentation.

    Trigger Employee Directory Import

    Trigger the migration of staged employee records from a named source into the live OfficeSpace employee directory. Use this endpoint after completing an Upsert Employees (Batch) operation to finalize the synchronization and make the updated employee data visible in OfficeSpace.

    • Enter the source system tag in the Source Name field. This is a required parameter. The Source Name must match the source tag used in the corresponding batch import step.

      • The default value is Nexla. Use this default value when the batch import was performed using Nexla's Upsert Employees (Batch) endpoint without a custom source tag.
      • If a custom source tag was used during batch import, enter that same tag here to ensure OfficeSpace imports the correct staged records.
    • Nexla will POST a request to the OfficeSpace employee directory import API endpoint at https://{hostname}.officespacesoftware.com/api/1/employee_directory, triggering OfficeSpace to move the staged employee records into the live directory.

    The Trigger Employee Directory Import endpoint is the second step in a two-stage employee synchronization workflow. Always run the Upsert Employees (Batch) endpoint first to stage employee records, then use this endpoint to commit those records to the live directory. Running this endpoint without a preceding batch import will have no effect.

Configure Manually​

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

Using manual configuration, you can also configure Nexla to automatically send the response received from the OfficeSpace 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 OfficeSpace Software API from the Method pulldown menu. For most OfficeSpace write operations, use POST (to create new records or trigger actions) or PUT (to update existing records).

Data Format​

  1. Select the format in which the Nexset data will be sent to the OfficeSpace Software API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. Most OfficeSpace API endpoints accept application/json — select JSON for standard data write operations. For the Trigger Employee Directory Import endpoint, select Form URL Encoded to match the application/x-www-form-urlencoded content type expected by that endpoint.

API Endpoint URL​

  1. Enter the URL of the OfficeSpace Software API endpoint to which you want to send the Nexset data in the URL field. OfficeSpace API endpoints follow the pattern https://{hostname}.officespacesoftware.com/api/1/{resource}, where {hostname} is your instance subdomain and {resource} is the target resource (e.g., employee_batch_imports, employee_directory). For update operations, include the ID of the object to be updated at the end of the URL.

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 the Authorization header or any other headers already present in the OfficeSpace credential. Nexla automatically appends the Authorization: Token token=<your_api_key> header on every API call based on your configured credential.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this OfficeSpace Software 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. Batching is recommended when sending large numbers of employee records to the OfficeSpace batch import endpoint, as it reduces the number of individual API calls and improves throughput.

  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.

Property Inside JSON Object

  1. Enter the name of the JSON property that should contain the batched records in the Property Name field.
  2. If any additional properties should be included in the request, enter the properties in the Other Props field in JSON format.

Code

  1. Enter the code that will be used to create the batched request in the code editor below the Grouping Algorithm field.

Response Webhook​

Optional

Nexla can automatically send the response received from the OfficeSpace 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.

  • 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 OfficeSpace 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 OfficeSpace 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 OfficeSpace 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 OfficeSpace Software endpoint, open the destination resource menu, and select Activate.

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