---
updatedAt: 2025-07-22T07:39:21.000Z
---
Fetch the complete documentation index at: https://apidocs.hibob.com/llms.txt. Use this file to discover all available pages before exploring further.
# Upload file to a Shared Folder
Use this endpoint to upload a file directly into a shared folder of a specific employee in Bob.
Make sure you set the right permissions to the Service User in order to upload the file. See more details in How to set up permissions for People's Docs .
# OpenAPI definition
```json
{
"openapi": "3.1.1",
"info": {
"title": "Docs API",
"description": "Use Public API to access Documents in Bob",
"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": "Documents",
"description": "Operations for managing documents in Bob"
},
{
"name": "Docs Webhooks",
"description": "Webhook events for document-related operations"
}
],
"webhooks": {
"documentsESignCompleted": {
"post": {
"operationId": "post_webhook_documents-eSign-completed",
"tags": [
"Docs Webhooks"
],
"summary": "Document eSign completion webhook",
"description": "Webhook sent when a document e-signing process is completed. The event will be sent at the end of the signing process. If the request has two signers and only one has signed, the event will not be sent until the second signer completes signing.\n\nIn the right panel, open **Examples** and select **Payload Example** to see a real payload.\n",
"parameters": [
{
"name": "bob-signature",
"in": "header",
"required": true,
"description": "Base64-encoded signature sent with each webhook request. Use it to verify that the request came from Bob. To verify webhook authenticity, see How does Bob calculate the signature.",
"schema": {
"type": "string",
"example": "EQScIBkAtTKFW0ictgt5zzOsqIc2+xGEsM88jOdLuW4CM/a3gLEfrKV+IC5IHx0xbirzLKPIfaZjCGwzuiyI8w=="
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentsESignCompletedEvent"
},
"example": {
"companyId": 12345,
"type": "documents.eSign.completed",
"triggeredBy": "system",
"triggeredAt": "2024-01-21T10:30:00Z",
"version": "v2",
"data": {
"documentId": 789,
"employeeId": "87726319283712973",
"downloadUrl": "https://app.hibob.com/api/docs/...",
"signedBy": "87726319283712973"
}
}
}
}
},
"responses": {
"200": {
"description": "Webhook received successfully"
},
"400": {
"description": "Invalid webhook payload",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": []
}
}
},
"paths": {
"/docs/people/{id}/shared/upload": {
"post": {
"operationId": "post_docs-people-id-shared-upload",
"tags": [
"Documents"
],
"summary": "Upload file to a Shared Folder",
"description": "Use this endpoint to upload a file directly into a shared folder of a specific employee in Bob.
Make sure you set the right permissions to the Service User in order to upload the file. See more details in How to set up permissions for People's Docs .",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the Employee. You can obtain the employee ID from the employee data.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"file"
],
"properties": {
"file": {
"type": "string",
"description": "The content of the file to upload.",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Uploaded document ID.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/docID"
}
}
}
},
"401": {
"description": "Authentication failed. Check your service user credentials",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "The service user or token is missing the required permissions to access the requested data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limit exceeded - see Rate limits",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"500": {
"description": "Unexpected error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"Basic": []
},
{
"Bearer": []
}
]
}
}
},
"components": {
"schemas": {
"docID": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "The ID (docId) of the document that was created. Use this when you need to pass the docID to other endpoints."
}
}
},
"Error": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The unique identifier of the error."
},
"error": {
"type": "string",
"description": "A human readable error message."
}
}
},
"WebhookEvent": {
"type": "object",
"description": "Base webhook event structure",
"properties": {
"companyId": {
"type": "integer",
"format": "int64",
"description": "The company ID"
},
"type": {
"type": "string",
"description": "The event type"
},
"triggeredBy": {
"type": "string",
"description": "Indicates who/what triggered the event. When set to \"system\", it means the event was triggered by an automated background process. \nCould also be an employee ID if triggered directly by a user action.\n"
},
"triggeredAt": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the event occurred"
},
"version": {
"type": "string",
"description": "The webhook version"
},
"data": {
"type": "object",
"description": "Contains the actual data and differs for each event type"
}
},
"required": [
"companyId",
"type",
"triggeredBy",
"triggeredAt",
"version",
"data"
]
},
"DocumentsESignCompletedEvent": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookEvent"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"documents.eSign.completed"
],
"description": "This event is sent at the end of the document e-signing process. If the request has two signers and only one has signed, the event will not be sent until the second signer completes their signing."
},
"data": {
"type": "object",
"description": "Event payload. Schema is defined by the webhook-integrations service (ESignCompletedEventData).",
"properties": {
"documentId": {
"type": "integer",
"format": "int64",
"description": "The backend ID of the document that was signed."
},
"employeeId": {
"type": "string",
"description": "The document owner — the employee whose document folder contains the signed document.\nRepresents the person the document was requested for (the target/recipient of the eSign request).\n"
},
"downloadUrl": {
"type": "string",
"description": "The download URL for the signed document."
},
"signedBy": {
"type": "string",
"description": "The last signer who completed the document — the person who added the final signature that triggered the completed event.\nMay be the employee, a manager, HR representative, or any other required signer.\n"
}
},
"required": [
"documentId",
"employeeId",
"downloadUrl",
"signedBy"
]
}
}
}
]
}
},
"securitySchemes": {
"Basic": {
"type": "http",
"scheme": "basic"
},
"Bearer": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "OAuth 2.0",
"description": "OAuth 2.0 authentication using an Access Token is available for registered partners only. Try It! does not support the full HiBob OAuth flow. You can follow these steps to complete the OAuth 2.0 flow in Postman and then paste the token here."
}
}
}
}
```