Push API

Overview

The Introist Push API allows you to push employee related data into Introist. This guide explains how to use the API endpoint, including the required authentication and JSON body format.

Creating Push API Data source

To create a Push API data source, navigate to Data ⇒ Data Sources.

Click "Connect Data Source" and select "Push API".

In the creation form, you may give a more descriptive name for the source as well as set an API key of your choosing. Make sure you have the API key stored in some secure password management solution as you will not see it again.

Click "Connect" and a new data source is created. You are ready to start pushing data!

Batch endpoint

• Method: POST

• URL: https://api.introist.com/ds/push/<datasource-id>/batch

• Replace <datasource-id> with the unique identifier for your data source that you can find from data source listing ⇒ Click more (three dots) for your Push API data source and then "Show params".

Authentication

To access this endpoint, you need an API key. Include the following header in your request:

Authorization: Bearer <api-key>

• Replace <api-key> with your actual API key.

• You have set your API key while creating the Push API data source.

Request Body

The request body must be a valid JSON array of objects. Currently there is no limit how many individual entries you may include in a single request. It is advisable to be mindful as the request time will increase if you include a large number of entries.

Below is an example format:

[{
  "id": "unique-identifier",
  "field1": "value1",
  "field2": "value2",
  ...
}]

Every entry must include the field id which uniquely identifies the employee in question.

Replace field1, field2, etc., with the fields and values specific to your use case. For detailed field requirements, consult the documentation or your account representative.

Example Request

Here is an example of a cURL request:

curl -X POST "https://api.introist.com/ds/push/1234/batch" \
-H "Authorization: Bearer 1234abcd" \
-H "Content-Type: application/json" \
-d '[{
  "id": "12345",
  "firstname": "John",
  "lastname": "Doe"
}]'

Common Issues and Troubleshooting

1. 401 Unauthorized Ensure your API key is valid and included in the request headers.

2. 404 Not Found Confirm the datasource-id is correct and exists in your account.

3. 400 Bad Request Verify the JSON body format.