Send passthrough request
Send a request to the specified integration’s native API.
At Kombo we put a lot of work into making sure that our unified API covers all our customers’ use cases and that they never have to think about integration-specific logic again. There are cases, however, where our customers want to build features that are very integration-specific. That’s where this endpoint comes in.
Pass in details about the request you want to make to the integration’s API and we’ll forward it for you. We’ll also take care of setting the right base URL and authenticating your requests.
To get started, please pick the relevant API (some tools provide multiple to due different base URLs or authentication schemes) from the table below and pass in the {tool}/{api}
identifier as part of the path.
Integration | {tool}/{api} | Description |
---|---|---|
Personio | personio/personnel | Personio’s Personnel Data API. We automatically authenticate all requests using the client ID and secret and use https://api.personio.de/v1 as the base URL. |
Workday | workday/soap | Workday’s SOAP API. We automatically authenticate all requests. Set data to your raw xml string. Use / as your path , as we will always send requests to https://{domain}/ccx/service/{tenant}/{service_name} . Set your method to POST . You need to specify the api_options object and set service_name to the name of the service you want to call. Find all available services here. The string that you submit as data will be the content of the soapenv:Body tag in the request. |
SAP SuccessFactors | successfactors/odata-v2 | SuccessFactors’ OData V2 API. We automatically authenticate all requests and use https://{api_domain}/odata/v2 as the base URL. |
SmartRecruiters | smartrecruiters/default | Smartrecruiters API. We automatically authenticate all requests using OAuth and use https://api.smartrecruiters.com as the base URL. |
SmartRecruiters | smartrecruiters/default | Smartrecruiters API. We automatically authenticate all requests using the credentials supplied by the customer and use https://api.smartrecruiters.com as the base URL. |
Lever | lever/v1 | Lever’s v1 API. We automatically authenticate all requests using the partner credentials which have been configured in the Lever tool settings (this uses Kombo’s partner credentials by default). |
Recruitee | recruitee/default | The Recruitee API. We automatically authenticate all requests and use https://api.recruitee.com/c/{company_id} as the base URL. |
Greenhouse | greenhouse/harvest | Greenhouse Harvest API. We automatically authenticate all requests using the API key and use https://harvest.greenhouse.io/v1 as the base URL. |
Teamtailor | teamtailor/v1 | Teamtailor’s JSON-API. We authenticate all request with the Teamtailor API key and use the base URL https://api.teamtailor.com/v1 . |
Personio | personio/recruiting | Personio’s Recruiting API. We automatically authenticate all requests using the Recruiting access token and use https://api.personio.de/v1/recruiting as the base URL. |
Personio | personio/jobboard | API endpoints exposed on Personio’s public job board pages (currently just the XML feed). We automatically use the right https://{company}.jobs.personio.de base URL. |
BambooHR | bamboohr/v1 | BambooHR’s API. We automatically authenticate all requests using the customer credentials https://api.bamboohr.com/api/gateway.php/{subdomain}/v1 as the base URL. |
Bullhorn | bullhorn/default | Bullhorn’s API. We automatically use the right https://rest{swimlane#}.bullhornstaffing.com/rest-services/{corpToken} base URL. |
Workable | workable/v1 | Workable’s API. We automatically authenticate all requests using the client ID and secret and use https://subdomain.workable.com/spi/v3 as the base URL. |
HiBob | hibob/v1 | HibBob’s v1 API. We automatically authenticate all requests using the service user credentials (or, for old integrations, the API key) and use https://api.hibob.com/v1 as the base URL. |
Cezanne HR | cezannehr/dataservice | CezanneHR’s v7 dataservice API.We automatically authenticate all requests and use the base URL https://subdomain.cezanneondemand.com/cezanneondemand/v7/dataservice.svc |
Microsoft Entra ID | entraid/v1 | AzureAD’s API. We automatically authenticate all requests. |
Microsoft Azure AD | azuread/v1 | AzureAD’s API. We automatically authenticate all requests. |
Pinpoint | pinpoint/v1 | Pinpoint’s JSON:API. We automatically authenticate all requests using the X-API-KEY header and use https://{subdomain}.pinpointhq.com/api/v1 as the base URL. |
Remote | remotecom/default | Remote’s API. We automatically authenticate all requests using provided credentials. |
TRAFFIT | traffit/v2 | Traffit’s v2 API. We authenticate all requests with the Traffit API key and use the base URL https://yourdomain.traffit.com/api/integration/v2 . |
Abacus Umantis | abacusumantis/v1 | Umantis API v1. We automatically authenticate all requests and use https://{subdomain}.umantis.com/api/v1 as the base URL. |
Haufe Umantis | umantis/v1 | Umantis API v1. We automatically authenticate all requests and use https://{subdomain}.umantis.com/api/v1 as the base URL. |
HRworks | hrworks/v2 | HRWorks’s v2 API. We automatically authenticate all requests using the customer credentials. |
JazzHR | jazzhr/v1 | JazzHR’s v1 API. We automatically authenticate all requests. |
Authorizations
Create an API key on the Secrets page in the Kombo dashboard.
Headers
ID of the integration you want to interact with.
Path Parameters
The ID of the tool whose passthrough API you want to call (e.g., personio
).
The ID of the passthrough API you want to call (some tools provide multiple). Check the endpoint description for a list of all available APIs.
Body
The HTTP method (e.g., GET
) of the request.
GET
, POST
, DELETE
, PUT
, PATCH
The path of the endpoint you want to call. We automatically prepend the base URL of the API (all base URLs are documented in the endpoint description).
The headers to send with the request. Note that we automatically supply any authentication-related headers.
The query parameters to send in addition to the ones in the path
.
The data to submit as part of the request body. This can either be an array or object (in which case we will forward it as JSON) or a string (in which case we will forward it raw).
If set to true
, the response will be returned as a base64-encoded string. This is useful for binary data (e.g., PDFs).
The data to submit as part of the request body if the request's Content-Type
is multipart/form-data
.
Custom options interpreted by the passthrough API adapter you've selected. These options are not documented right now as they're only for very advanced use cases.
Response
success