Sign Up for Free
Sign In

document.created

Fires when a document (file) is created. Folder creation does not fire.

01

Payload fields

Fields below arrive inside the payload key of the standard request envelope.

FieldTypeDescription
id integer The document's unique ID in Preserve.
name string Document name.
description string | null Description, if provided.
organization_id integer Owning org ID. Org-level documents only.
organization string Owning org display name. Org-level documents only.
site_id integer Owning site ID. Site-level documents only.
site string Owning site display name. Site-level documents only.
url string Link to the document in Preserve. Requires a signed-in user with access.

02

Example deliveries

org-level document
{
  "hook": {
    "name": "My Integration"
  },
  "event": "document.created",
  "payload": {
    "id": 42,
    "name": "Pump Maintenance Manual",
    "description": "OEM manual",
    "organization_id": 7,
    "organization": "Acme Energy",
    "url": "https://app.example.com/documents/42"
  }
}
site-level document
{
  "hook": {
    "name": "My Integration"
  },
  "event": "document.created",
  "payload": {
    "id": 43,
    "name": "Pump Maintenance Manual",
    "description": "OEM manual",
    "site_id": 12,
    "site": "Riverside Plant",
    "url": "https://app.example.com/documents/43"
  }
}
← All webhook events
Preserve Logo

Preserve

Introducing our groundbreaking application designed to serve as an indispensable operational toolbox to technicians in the field.

I am interested in hearing about early adoption licensing rates!

*
*
Pricing Roadmap API Docs