---
updatedAt: 2026-04-29T08:24:53.000Z
---
Fetch the complete documentation index at: https://apidocs.hibob.com/llms.txt. Use this file to discover all available pages before exploring further.
# Create integration
Registers a new LMS integration for the company. Once created, use the `providerIdentifier` as the `provider-identifier` path parameter to push training content and submit learner progress.
**Before using this endpoint:**
- Obtain the provider identifier from your Learning provider — this is the stable key used to register the integration.
- If you are using a service user, ensure it has the relevant permissions. See Required permissions.
- If you are developing an app, ensure it has the relevant scopes. See Required permissions.
**Testing notes:** Open the **Examples** panel and select a **Request Example** to inspect the body parameters.
# OpenAPI definition
```json
{
"openapi": "3.1.1",
"info": {
"title": "Bob Learning API",
"description": "Public API for partner Learning integrations: register an integration, push and update training content in bulk, archive content, and submit xAPI progress statements.",
"license": {
"name": "Proprietary",
"url": "https://apidocs.hibob.com/docs/api-terms-of-use"
},
"contact": {
"name": "Hi Bob, Inc."
},
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.hibob.com/v1",
"description": "Production"
},
{
"url": "https://api.sandbox.hibob.com/v1",
"description": "Sandbox"
}
],
"x-readme": {
"metrics-enabled": false
},
"tags": [
{
"name": "Provider integrations",
"description": "Register and remove partner LMS integrations, manage training content, and submit xAPI progress statements"
}
],
"paths": {
"/learning/lms-integrations": {
"post": {
"operationId": "post_learning-lms-integrations",
"tags": [
"Provider integrations"
],
"summary": "Create integration",
"description": "Registers a new LMS integration for the company. Once created, use the `providerIdentifier` as the `provider-identifier` path parameter to push training content and submit learner progress.\n\n**Before using this endpoint:**\n\n - Obtain the provider identifier from your Learning provider — this is the stable key used to register the integration.
\n - If you are using a service user, ensure it has the relevant permissions. See Required permissions.
\n - If you are developing an app, ensure it has the relevant scopes. See Required permissions.
\n
\n\n**Testing notes:** Open the **Examples** panel and select a **Request Example** to inspect the body parameters.\n",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePartnerIntegrationRequest"
},
"examples": {
"unlinked": {
"summary": "Unlinked provider with display name",
"value": {
"providerIdentifier": "unlinked",
"displayName": "UnLinked Learning"
}
},
"minimalProvider": {
"summary": "Provider identifier only (no display name)",
"description": "When displayName is omitted, it defaults to `{providerIdentifier}_Integration`.",
"value": {
"providerIdentifier": "acme-lms"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Integration created successfully. Response body is empty."
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"401": {
"description": "Authentication failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden — missing required permissions",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Not found — LMS integration feature is not enabled for this company",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Conflict — an integration for this provider already exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"422": {
"description": "Unprocessable entity — invalid configuration (for example, display name exceeds 256 characters)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"429": {
"description": "Rate limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"security": [
{
"basic": []
},
{
"Bearer": []
}
],
"x-internal": false
}
}
},
"components": {
"securitySchemes": {
"basic": {
"type": "http",
"scheme": "basic",
"description": "Basic HTTP authentication using service user credentials"
},
"Bearer": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "OAuth 2.0",
"description": "OAuth 2.0 access token. Complete the OAuth 2.0 flow in Postman, then paste the token here. Learn more about OAuth 2.0 in HiBob"
}
},
"schemas": {
"ApiErrorResponse": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Error key identifier"
},
"error": {
"type": "string",
"description": "Human-readable error message"
},
"args": {
"type": "array",
"description": "Optional error arguments providing additional context",
"items": {
"type": "string"
}
}
}
},
"CreatePartnerIntegrationRequest": {
"type": "object",
"description": "Request body for creating an LMS integration (flat structure).",
"required": [
"providerIdentifier"
],
"properties": {
"providerIdentifier": {
"type": "string",
"description": "Stable provider key (for example `unlinked`). Validated by `PartnerIntegrationResolver.validateProviderIdentifier`."
},
"displayName": {
"type": "string",
"description": "Display name for the integration. If omitted or blank, defaults to `{providerIdentifier}_Integration`. Maximum length 256 characters."
}
}
}
}
}
}
```