Documents

document_created

Payload data sent after document creation.

Properties

Property Type Format Required Description
type string true Payload type (document_created)
actionUserId string UUID true User identifier
actionExternalUserId string false User external identifier
projectId string UUID true Project identifier
projectExternalId string false Project external identifier
organizationId string UUID true Organization identifier (if document belongs to the organization)
data Document – true Created payload date

Example

{
  "type": "document_created",
  "projectId": "310c5fda-906d-4f44-bf4d-a51d5ef55b99",
  "projectExternalId": "1",
  "actionUserId": "110c5fda-226d-4f44-bf4d-a11d5ef55b33",
  "actionExternalUserId": "externalId",
  "organizationId": null,
  "data": {
    "id": "1f2c07bc-a333-49a3-bb39-287f49d3b50b",
    "parentId": "6d076738-53b1-4a31-9cd5-7c43d7180cd3",
    "revisionKey": "80ee476b-3869-424c-bcfd-ab96924eb609",
    "revisionNumber": 1,
    "isPrivate": false,
    "title": "Example document title",
    "comment": null,
    "authorId": "f8298546-fde8-4e49-a9ce-a88f6bc5faa6"
  }
}

document_created_revision

Payload data sent after document revision creation.

Properties

Property Type Format Required Description
type string true Payload type (document_created_revision)
actionUserId string UUID true User identifier
actionExternalUserId string false User external identifier
projectId string UUID true Project identifier
projectExternalId string false Project external identifier
organizationId string UUID true Organization identifier (if document belongs to the organization)
data Document – true Created payload date

Example

{
  "type": "document_created_revision",
  "projectId": "310c5fda-906d-4f44-bf4d-a51d5ef55b99",
  "projectExternalId": "1",
  "actionUserId": "110c5fda-226d-4f44-bf4d-a11d5ef55b33",
  "actionExternalUserId": "externalId",
  "organizationId": null,
  "data": {
    "id": "1f2c07bc-a333-49a3-bb39-287f49d3b50b",
    "parentId": "6d076738-53b1-4a31-9cd5-7c43d7180cd3",
    "revisionKey": "80ee476b-3869-424c-bcfd-ab96924eb609",
    "revisionNumber": 1,
    "isPrivate": false,
    "title": "Example document title",
    "comment": null,
    "authorId": "f8298546-fde8-4e49-a9ce-a88f6bc5faa6"
  }
}

document_updated

Payload data sent after single document update (eg. title, comment or parent folder)

Properties

Property Type Format Required Description
type string true Payload type (document_updated)
actionUserId string UUID true User identifier
actionExternalUserId string false User external identifier
projectId string UUID true Project identifier
projectExternalId string false Project external identifier
organizationId string UUID true Organization identifier (if document belongs to the organization)
data Document – true Created payload date

Example

{
  "type": "document_updated",
  "projectId": "310c5fda-906d-4f44-bf4d-a51d5ef55b99",
  "projectExternalId": "1",
  "actionUserId": "110c5fda-226d-4f44-bf4d-a11d5ef55b33",
  "actionExternalUserId": "externalId",
  "organizationId": null,
  "data": {
    "id": "1f2c07bc-a333-49a3-bb39-287f49d3b50b",
    "parentId": "6d076738-53b1-4a31-9cd5-7c43d7180cd3",
    "revisionKey": "80ee476b-3869-424c-bcfd-ab96924eb609",
    "revisionNumber": 1,
    "isPrivate": false,
    "title": "Example document title",
    "comment": null,
    "authorId": "f8298546-fde8-4e49-a9ce-a88f6bc5faa6"
  }
}

document_removed

Payload data sent after document (with all revisions) remove.

Properties

Property Type Format Required Description
type string true Payload type (document_removed)
actionUserId string UUID true User identifier
actionExternalUserId string false User external identifier
projectId string UUID true Project identifier
projectExternalId string false Project external identifier
organizationId string UUID true Organization identifier (if document belongs to the organization)
data Document – true Created payload date

Example

{
  "type": "document_removed",
  "projectId": "310c5fda-906d-4f44-bf4d-a51d5ef55b99",
  "projectExternalId": "1",
  "actionUserId": "110c5fda-226d-4f44-bf4d-a11d5ef55b33",
  "actionExternalUserId": "externalId",
  "organizationId": null,
  "data": {
    "id": "1f2c07bc-a333-49a3-bb39-287f49d3b50b",
    "parentId": "6d076738-53b1-4a31-9cd5-7c43d7180cd3",
    "revisionKey": "80ee476b-3869-424c-bcfd-ab96924eb609",
    "revisionNumber": 1,
    "isPrivate": false,
    "title": "Example document title",
    "comment": null,
    "authorId": "f8298546-fde8-4e49-a9ce-a88f6bc5faa6"
  }
}

document_removed_revision

Payload data sent after single document revision remove.

Properties

Property Type Format Required Description
type string true Payload type (document_removed_revision)
actionUserId string UUID true User identifier
actionExternalUserId string false User external identifier
projectId string UUID true Project identifier
projectExternalId string false Project external identifier
organizationId string UUID true Organization identifier (if document belongs to the organization)
data Document – true Created payload date

Example

{
  "type": "document_removed_revision",
  "projectId": "310c5fda-906d-4f44-bf4d-a51d5ef55b99",
  "projectExternalId": "1",
  "actionUserId": "110c5fda-226d-4f44-bf4d-a11d5ef55b33",
  "actionExternalUserId": "externalId",
  "organizationId": null,
  "data": {
    "id": "1f2c07bc-a333-49a3-bb39-287f49d3b50b",
    "parentId": "6d076738-53b1-4a31-9cd5-7c43d7180cd3",
    "revisionKey": "80ee476b-3869-424c-bcfd-ab96924eb609",
    "revisionNumber": 1,
    "isPrivate": false,
    "title": "Example document title",
    "comment": null,
    "authorId": "f8298546-fde8-4e49-a9ce-a88f6bc5faa6"
  }
}

results matching ""

    No results matching ""