Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Webhooks

Documents > Document > Updates

Subscription_type: documents/document/update

postWebhookWebhooks > Documents > Document > Updates

Payload

author_idstring

access identifier of the author, refers to /employees/employees endpoint.

company_idstring

company identifier, refers to /api/me endpoint.

content_typestring

document content type.

created_atstring required

creation date of the document.

employee_idstring

employee identifier associated to the document.

extensionstring

document extension.

file_sizeinteger

document file size in bytes.

filenamestring required

name of the document.

folder_idstring

folder identifier, references to documents/folders endpoint.

idstring required

document identifier.

is_company_documentboolean

flag that indicates if the document is a company document.

is_management_documentboolean

flag that indicates if the document is a management document.

is_pending_assignmentboolean

flag that indicates if the document is pending assignment.

leave_idstring

leave identifier associated to the document, refers to /timeoff/leaves endpoint.

publicboolean required

flag to indicate if the document is public.

signature_status'pending' | 'partially_signed' | 'declined' | 'completed' | 'bounced_email' | 'cancelled' | 'error' | 'expired'

document signature status.

signeesstring[]

list of signee access identifiers associated to the document, refers to /employees/employees endpoint.

spacestring required

document space.

updated_atstring required

last update date of the document.

deleted_atstring

deletion date of the document.

Example payload

{
  "author_id": "1",
  "company_id": "1",
  "content_type": "application/pdf",
  "created_at": "2020-01-01T00:00:00Z",
  "employee_id": "1",
  "extension": "pdf",
  "file_size": 1024,
  "filename": "document.pdf",
  "folder_id": "1",
  "id": "1",
  "is_company_document": true,
  "is_management_document": true,
  "is_pending_assignment": true,
  "leave_id": "1",
  "public": true,
  "signature_status": "pending",
  "space": "company_public",
  "updated_at": "2020-01-01T00:00:00Z",
  "deleted_at": "2020-01-01T00:00:00Z"
}

Response

Return a 200 status to indicate that the data was received successfully