Skip to main content

Deputy 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 Deputy location.
deputy_api.png

Deputy

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

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

  3. Deputy destinations can be manually configured to send data to any valid Deputy API endpoint. The Deputy REST API accepts JSON-formatted data at endpoints following the pattern https://{installname}.{geo}.deputy.com/api/v1/resource/{ResourceName}, where {installname} is your Deputy install name, {geo} is your geographic region (e.g., na, eu, or au), and {ResourceName} is the Deputy resource type (e.g., Employee, Timesheet, Roster).

    You can also configure Nexla to automatically send the response received from the Deputy API after each call to a new Nexla webhook data source.

    First, select the API method that will be used for calls to the Deputy API from the Method pulldown menu.

The Deputy API uses standard HTTP methods for data operations. Use POST to create new records, PUT to fully replace existing records, and PATCH for partial updates. Each Deputy resource endpoint follows a consistent RESTful pattern. For complete information about supported methods per resource, refer to the Deputy API documentation.

Data Format​

  1. Select the format in which the Nexset data will be sent to the Deputy API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call.

The Deputy API expects data in JSON format. Select JSON as the content format to ensure compatibility with Deputy API endpoints.

API Endpoint URL​

  1. Enter the URL of the Deputy API endpoint to which you want to send the Nexset data in the URL field. For update or upsert operations, include the ID of the Deputy record to be updated at the end of the URL.

    Common Deputy API write endpoints include:

    • Create Employee: https://{installname}.{geo}.deputy.com/api/v1/resource/Employee
    • Update Employee: https://{installname}.{geo}.deputy.com/api/v1/resource/Employee/{id}
    • Create Timesheet: https://{installname}.{geo}.deputy.com/api/v1/resource/Timesheet
    • Create Roster: https://{installname}.{geo}.deputy.com/api/v1/resource/Roster
    • Create Leave Request: https://{installname}.{geo}.deputy.com/api/v1/resource/Leave

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. The Deputy API uses Bearer token authentication, which is handled automatically by Nexla based on your credential configuration.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Deputy 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 Deputy 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 Deputy 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​

After all endpoint settings have been configured, Nexla can send a test payload to the Deputy 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 Deputy 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 send the data to the configured Deputy endpoint, open the destination resource menu, and select Activate.

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