Skip to main content

Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that sends data to a Personio location.
personio_api.png

Personio

Create a Personio Destination​

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

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

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

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

    This endpoint template creates company data such as employees, attendance data, time-offs, or absence-periods in your Personio account using records from a Nexset. Use this template when you need to create new employees, attendance records, time-off requests, or absence periods in your Personio account.

    • Enter the data type in the Data Type field. This should be the type of company data you want to create (e.g., employees, attendances, time-offs, absence-periods). The data type determines which Personio resource will be created.

    This endpoint sends data as JSON in the request body to create company data in your Personio account. Each record from your Nexset will be sent as a separate API request to create company data in Personio. The request body should contain the company data in the format required by the Personio API.

    The company data structure must match the Personio API's expected format. For detailed information about company data creation, request body formats, available data types, and resource management, see the Personio API documentation.

    Upload Documents

    This endpoint template uploads documents for company employees in your Personio account using records from a Nexset. Use this template when you need to upload employee documents, such as contracts, certificates, or other employee-related documents.

    • This endpoint automatically uploads documents from your data. No additional configuration is required beyond selecting this endpoint template. The request body should contain the document data in JSON format matching the Personio API structure.

    This endpoint sends data as JSON in the request body to upload documents for company employees in your Personio account. Each record from your Nexset will be sent as a separate API request to upload a document in Personio. The request body should contain the document data in the format required by the Personio API.

    The document structure must match the Personio API's expected format. For detailed information about document upload, request body formats, available document properties, and document management, see the Personio API documentation.

Configure Manually​

Personio destinations can be manually configured to send data to any valid Personio API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Personio 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 Personio API from the Method pulldown menu. Personio API typically uses POST method for creating resources.

Data Format​

  1. Select the format in which the Nexset data will be sent to the Personio API from the Content Format pulldown menu. Personio API expects JSON format for all requests.

API Endpoint URL​

  1. Enter the URL of the Personio API endpoint to which data will be sent in the URL field. This should be the complete URL to your Personio endpoint (e.g., https://api.personio.de/v1/company/employees, https://api.personio.de/v1/company/documents). Include any required path parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The Personio API endpoint URL should point to the endpoint where you want to create resources. The endpoint URL should include the API version (/v1/) and the resource type path. You can test the endpoint using the Test button after configuring the URL.

Request Body​

  1. Configure the request body that will be sent to the Personio API. The request body should contain the resource data formatted as JSON, with field names matching the Personio API's expected structure. The request body format is typically {message.json} to send the entire Nexset data as JSON, or you can construct a custom JSON structure with specific field mappings.

The request body must be valid JSON and must match the Personio API's expected format for the specific endpoint you're using. Personio API uses specific structures for different endpoints (employees, attendances, documents, etc.). For detailed information about request body formats, available endpoints, and resource structures, see the Personio API documentation.

Save the Destination​

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the destination configuration for later use.