vault.document.created

Event

vault.document.created

This event fires when a file is added to Documents Vault: when a user finishes uploading a file, or when folder sync imports a new file from a connected drive.

Payload Example

{
  "event": "vault.document.created",
  "event_id": "3f7c1a8e-5b2d-4e9a-9c31-8a6f0d4b7e12",
  "organization_id": 42,
  "user_id": 1337,
  "payload_version": 1,
  "timestamp": "2026-09-24T14:32:00Z",
  "data": {
    "event": "vault.document.created",
    "resource_id": "5e2b8c17-3d4a-4f6e-a9b1-7c0d2e8f4a63",
    "resource_type": "file",
    "name": "Mutual NDA - Contoso.pdf",
    "parent_folder_id": "7b3e9d20-4c1f-4a8e-b5d6-2f9a0c8e1d47",
    "path": "u1337.Legal.Vendor_Contracts.Mutual_NDA___Contoso_pdf",
    "external_source": null,
    "external_id": null
  }
}

Payload Fields

Envelope

Field	Type	Description
`event`	string	Always `vault.document.created`
`event_id`	string	UUID for this delivery. Use it to deduplicate retries
`organization_id`	integer	ID of the organization the event occurred in
`user_id`	integer or null	ID of the user who made the change. For changes made by folder sync, the user who owns the sync
`payload_version`	integer	Envelope schema version. Currently `1`
`timestamp`	string	ISO 8601 UTC timestamp of when the event was generated
`data`	object	Event-specific payload (see below)

Data Object

Field	Type	Description
`event`	string	The event name, repeated from the envelope
`resource_id`	string	UUID of the file in Documents Vault
`resource_type`	string	Always `file`
`name`	string	Name of the file
`parent_folder_id`	string or null	UUID of the folder that contains the file. `null` when the file is at the top level of the vault
`path`	string or null	Internal hierarchical path of the file (see Path format)
`external_source`	string or null	The external drive the file is synced with, for example `google_drive`. `null` for items created in Chamelio
`external_id`	string or null	The file’s ID in the external drive, when `external_source` is set

Path format

path is an internal dot-separated path, not a display path. Each segment is a sanitized label: characters other than letters, digits, and underscores become _. For example, a file named Q3 NDA.pdf appears as a Q3_NDA_pdf segment. Use resource_id and parent_folder_id to identify items and rebuild the hierarchy; treat path as informational.

Files imported by folder sync also fire this event, with external_source and external_id set. Check external_source if you only want files your users uploaded.

Overview

API Key Access

OAuth App Access

MCP (beta)

Webhooks

Event

Payload Example

Payload Fields

Envelope

Data Object

Path format

​Event

​Payload Example

​Payload Fields

​Envelope

​Data Object

​Path format

Event

Payload Example

Payload Fields

Envelope

Data Object

Path format