Properties
| Name | Type | Description |
|---|---|---|
| status | string | |
| data | object | |
| warnings | array | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/PostHrisEmployeesFormPositiveResponse",
"title": "PostHrisEmployeesFormPositiveResponse",
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "success"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": [
"string",
"null"
],
"description": "The Kombo id of the created employee. If null, we only created a pre-hire which shows up in the next sync after a successful onboarding."
},
"remote_id": {
"type": [
"string",
"null"
],
"description": "The raw ID of the created employee in the remote system. This is only populated when `id` is set (i.e., when a full employee was created). For pre-hires, use the `prehire` object instead."
},
"prehire": {
"type": "object",
"properties": {
"remote_id": {
"type": [
"string",
"null"
],
"description": "The temporary ID returned by the remote system when creating a pre-hire."
}
},
"required": [
"remote_id"
],
"description": "An object containing the temporary pre-hire information from the remote system. This ID may change or become invalid when the pre-hire becomes a full employee. Only populated when `id` is null."
}
},
"required": [
"id",
"remote_id",
"prehire"
],
"examples": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "12345",
"prehire": {
"remote_id": null
}
}
]
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
},
"description": "These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console."
}
},
"required": [
"status",
"data",
"warnings"
]
}