Documill Leap
Documill Leap
Breadcrumbs

Workflow Log

Available to Workflow Owner and Organization Admin.

Workflow Log helps to audit activity that happened to a Workflow. To know the activities that are recorded into Workflow Log, please refer to the list of Event Types below.

You can access the Workflow Log in two ways:

  • From the UI, by opening the Workflow and click the [Log] button.

  • From the External API Endpoints.

Note that, when a Workflow is deleted, the Log data of the Workflow will also be deleted.

Access Workflow Log via UI

You can access the Log of a Workflow by editing the Workflow and click the [Log] button.

Workflow Log view.jpg

The Workflow Log can also be exported as a CSV and PDF file.


External API to retrieve Workflow Log

Workflow Log is also available through External API Endpoint. These are the details of the External API to retrieve the log of a Workflow:

Method

GET

API endpoint path

https://api.leap.documill.com/api/v1/external/projects/events/{workflowId}

Content-Type

header

application/json

Accept

header

application/json

Authorization

header

Your External API Key

request

path

Replace the {workflowId} in the API endpoint path with the id of the workflow that you would like to see.

One way to retrieve the Workflow ID is by checking the browser’s address bar when editing the Workflow:

Workflow ID from URL.jpg


To call this External API endpoint, please follow the tutorial on how to use External API Endpoints: Using External API Endpoints .


Event types and example data

The Workflow Log records different kind of events, from renaming the workflow, to changes in its structure. These events are grouped by their Event Types. You can find the Event Types and their example data in the table below:

Event Types

Example data

WORKFLOW_TEMPLATE_CREATION
Click to expand...

{
    "id": "99c1bb3c-e2ed-4d5c-ae5d-644f24ac1dfc",
    "collaboratorId": "4efec053-8bee-48ce-8b00-11ac47029894",
    "collaboratorEmail": "craig.example@example.com",
    "collaboratorFullName": "Craig Example",
    "creationDate": "2024-06-11T12:03:41.431+00:00",
    "eventTags": {
      "project-name": "Untitled Workflow",
      "project-description": null,
      "project-id": "0619b833-118c-468b-8bbd-dbfef2f716d5",
      "project-status": "PLANNING"
    },
    "eventType": "WORKFLOW_TEMPLATE_CREATION",
    "status": "SUCCESS"
  }

WORKFLOW_TEMPLATE_DESCRIPTION_CHANGE
Click to expand...

{
    "id": "6e0704d8-aca4-491a-ade1-fa9a389c7136",
    "collaboratorId": "4efec053-8bee-48ce-8b00-11ac47029894",
    "collaboratorEmail": "craig.example@example.com",
    "collaboratorFullName": "Craig Example",
    "creationDate": "2024-06-11T12:12:27.028+00:00",
    "eventTags": {
      "project-name": "Agreement Template - 2025",
      "project-description": "Template for creating Agreement document.",
      "project-id": "0619b833-118c-468b-8bbd-dbfef2f716d5",
      "project-status": "PLANNING"
    },
    "eventType": "WORKFLOW_TEMPLATE_DESCRIPTION_CHANGE",
    "status": "SUCCESS"
  }

WORKFLOW_TEMPLATE_RENAME
Click to expand...

{
    "id": "e128c7a5-d733-44df-a7d3-c1060220d1ff",
    "collaboratorId": "4efec053-8bee-48ce-8b00-11ac47029894",
    "collaboratorEmail": "craig.example@example.com",
    "collaboratorFullName": "Craig Example",
    "creationDate": "2024-06-11T12:11:18.341+00:00",
    "eventTags": {
      "project-name": "Agreement Template - 2025",
      "project-description": null,
      "project-id": "0619b833-118c-468b-8bbd-dbfef2f716d5",
      "project-status": "PLANNING"
    },
    "eventType": "WORKFLOW_TEMPLATE_RENAME",
    "status": "SUCCESS"
  }

WORKFLOW_TEMPLATE_SETTINGS_CHANGE
Click to expand...

{
    "id": "ecffbdfd-2cbf-45e6-ba40-be5e33787d94",
    "collaboratorId": "4efec053-8bee-48ce-8b00-11ac47029894",
    "collaboratorEmail": "craig.example@example.com",
    "collaboratorFullName": "Craig Example",
    "creationDate": "2024-06-11T12:13:32.987+00:00",
    "eventTags": {
      "project-name": "Agreement Template - 2025",
      "project-description": "Template for creating Agreement document.",
      "project-id": "0619b833-118c-468b-8bbd-dbfef2f716d5",
      "project-status": "PLANNING"
    },
    "eventType": "WORKFLOW_TEMPLATE_SETTINGS_CHANGE",
    "status": "SUCCESS"
  }

PHASE_CREATION
Click to expand...

{
    "id": "85ea32c4-def5-4f5a-a078-ca02d87ce734",
    "collaboratorId": "4efec053-8bee-48ce-8b00-11ac47029894",
    "collaboratorEmail": "craig.example@example.com",
    "collaboratorFullName": "Craig Example",
    "creationDate": "2024-06-11T12:03:41.750+00:00",
    "eventTags": {
      "phase-id": "92fbbb37-1388-480a-8b04-b613e0b1776a",
      "phase-name": "Preparation",
      "phase-type": "EDITING"
    },
    "eventType": "PHASE_CREATION",
    "status": "SUCCESS"
  }

PHASE_DELETION
Click to expand...

{
    "id": "b8c16899-1e74-47f0-8e8c-f3295e8f6dbc",
    "collaboratorId": "4efec053-8bee-48ce-8b00-11ac47029894",
    "collaboratorEmail": "craig.example@example.com",
    "collaboratorFullName": "Craig Example",
    "creationDate": "2024-06-11T12:17:13.158+00:00",
    "eventTags": {
      "phase-id": "d4c18a61-5525-45dc-8d10-2babbbed3e00",
      "phase-name": "Approval by Legal",
      "phase-type": "APPROVING"
    },
    "eventType": "PHASE_DELETION",
    "status": "SUCCESS"
  }

PHASE_RENAME
Click to expand...

{
    "id": "8225da42-ccc1-4db7-ac4c-874e80cc8c55",
    "collaboratorId": "4efec053-8bee-48ce-8b00-11ac47029894",
    "collaboratorEmail": "craig.example@example.com",
    "collaboratorFullName": "Craig Example",
    "creationDate": "2024-06-11T12:14:30.614+00:00",
    "eventTags": {
      "phase-id": "d4c18a61-5525-45dc-8d10-2babbbed3e00",
      "phase-name": "Approval by Legal",
      "phase-type": "APPROVING"
    },
    "eventType": "PHASE_RENAME",
    "status": "SUCCESS"
  }

PHASE_MOVE
Click to expand...

{
    "id": "e09eb3bd-072b-46d0-b000-48045a1c6360",
    "collaboratorId": "4efec053-8bee-48ce-8b00-11ac47029894",
    "collaboratorEmail": "craig.example@example.com",
    "collaboratorFullName": "Craig Example",
    "creationDate": "2024-06-11T12:14:54.384+00:00",
    "eventTags": {
      "phase-id": "d4c18a61-5525-45dc-8d10-2babbbed3e00",
      "phase-name": "Approval by Legal",
      "phase-type": "APPROVING"
    },
    "eventType": "PHASE_MOVE",
    "status": "SUCCESS"
  }

STEP_CREATION
Click to expand...

  {
    "id": "038aee6b-e730-47fe-9d2e-8d8ea46eb2d2",
    "collaboratorId": "4efec053-8bee-48ce-8b00-11ac47029894",
    "collaboratorEmail": "craig.example@example.com",
    "collaboratorFullName": "Craig Example",
    "creationDate": "2024-06-11T12:03:42.942+00:00",
    "eventTags": {
      "step-goal": "DELIVER",
      "step-id": "315adab1-0afd-48b3-9ccd-c40b24e384b4",
      "step-status": "UPCOMING"
    },
    "eventType": "STEP_CREATION",
    "status": "SUCCESS"
  }

STEP_DELETION
Click to expand...

  {
    "id": "cdccb3f3-d801-47da-a904-f9299c92a290",
    "collaboratorId": "4efec053-8bee-48ce-8b00-11ac47029894",
    "collaboratorEmail": "craig.example@example.com",
    "collaboratorFullName": "Craig Example",
    "creationDate": "2024-06-11T12:18:48.793+00:00",
    "eventTags": {
      "step-goal": "REVIEW",
      "step-id": "5403f1a9-437b-45ad-8340-68819cb50389",
      "step-status": "UPCOMING"
    },
    "eventType": "STEP_DELETION",
    "status": "SUCCESS"
  }

STEP_MOVE
Click to expand...

  {
    "id": "961a9e8b-9c02-440e-972b-d6ba7e8183ae",
    "collaboratorId": "4efec053-8bee-48ce-8b00-11ac47029894",
    "collaboratorEmail": "craig.example@example.com",
    "collaboratorFullName": "Craig Example",
    "creationDate": "2024-06-11T12:16:44.099+00:00",
    "eventTags": {
      "step-goal": "EDIT",
      "step-id": "d94cfb3e-2e19-466d-90d5-dbb57a210d10",
      "step-status": "UPCOMING"
    },
    "eventType": "STEP_MOVE",
    "status": "SUCCESS"
  }

COLLABORATOR_CREATION
Click to expand...

  {
    "id": "f03ac1b4-c8db-4a14-8798-7b847c30a53e",
    "collaboratorId": "4efec053-8bee-48ce-8b00-11ac47029894",
    "collaboratorEmail": "craig.example@example.com",
    "collaboratorFullName": "Craig Example",
    "creationDate": "2024-06-11T12:20:06.031+00:00",
    "eventTags": {
      "collaborator-id": "2281537e-ef85-49d6-8225-25e3cd249458",
      "collaborator-email": "alice.example@example.com",
      "collaborator-name": "Alice Example",
      "collaborator-project-role": "COLLABORATOR"
    },
    "eventType": "COLLABORATOR_CREATION",
    "status": "SUCCESS"
  }

COLLABORATOR_DELETION
Click to expand...

  {
    "id": "ed3da03c-903b-40a2-9669-0f3350bbff86",
    "collaboratorId": "4efec053-8bee-48ce-8b00-11ac47029894",
    "collaboratorEmail": "craig.example@example.com",
    "collaboratorFullName": "Craig Example",
    "creationDate": "2024-06-12T07:58:22.342+00:00",
    "eventTags": {
      "collaborator-id": "2281537e-ef85-49d6-8225-25e3cd249458",
      "collaborator-email": "alice.example@example.com",
      "collaborator-name": "Alice Example",
      "collaborator-project-role": "INACTIVE"
    },
    "eventType": "COLLABORATOR_DELETION",
    "status": "SUCCESS"
  }

COLLABORATOR_ROLE_CHANGE
Click to expand...

  {
    "id": "791f7e48-95d6-4df6-ba05-0837e09825a3",
    "collaboratorId": "4efec053-8bee-48ce-8b00-11ac47029894",
    "collaboratorEmail": "craig.example@example.com",
    "collaboratorFullName": "Craig Example",
    "creationDate": "2024-06-12T07:57:59.351+00:00",
    "eventTags": {
      "collaborator-id": "239df2bb-2189-4cba-81cc-481f07c7ba35",
      "collaborator-email": "bob.example@example.com",
      "collaborator-name": "Bob Example",
      "collaborator-project-role": "PROJECT_OWNER"
    },
    "eventType": "COLLABORATOR_ROLE_CHANGE",
    "status": "SUCCESS"
  }

TASK_CREATION
Click to expand...

  {
    "id": "2d714a11-f509-4d8a-bc3b-ae8018795e56",
    "collaboratorId": "4efec053-8bee-48ce-8b00-11ac47029894",
    "collaboratorEmail": "craig.example@example.com",
    "collaboratorFullName": "Craig Example",
    "creationDate": "2024-06-11T12:20:43.375+00:00",
    "eventTags": {
      "collaborator-id": "239df2bb-2189-4cba-81cc-481f07c7ba35",
      "collaborator-email": "bob.example@example.com",
      "collaborator-name": "Bob Example",
      "collaborator-project-role": "COLLABORATOR",
      "task-role": "SIGNER",
      "task-status": "UPCOMING",
      "task-id": "e21e8388-e268-42dd-8684-830fa0d12f6d"
    },
    "eventType": "TASK_CREATION",
    "status": "SUCCESS"
  }

TASK_DELETION
Click to expand...

  {
    "id": "61854e71-b1ce-40a8-8c4b-6619d38d7bc5",
    "collaboratorId": "4efec053-8bee-48ce-8b00-11ac47029894",
    "collaboratorEmail": "craig.example@example.com",
    "collaboratorFullName": "Craig Example",
    "creationDate": "2024-06-12T07:56:23.669+00:00",
    "eventTags": {
      "collaborator-id": "239df2bb-2189-4cba-81cc-481f07c7ba35",
      "collaborator-email": "bob.example@example.com",
      "collaborator-name": "Bob Example",
      "collaborator-project-role": "COLLABORATOR",
      "task-role": "INTERNAL_READER",
      "task-status": "UPCOMING",
      "task-id": "37b31820-d883-46da-8429-cd446810c586"
    },
    "eventType": "TASK_DELETION",
    "status": "SUCCESS"
  }

TASK_ROLE_CHANGE
Click to expand...

  {
    "id": "075e74e4-4fe6-4d96-bfc7-a23ea80edf50",
    "collaboratorId": "4efec053-8bee-48ce-8b00-11ac47029894",
    "collaboratorEmail": "craig.example@example.com",
    "collaboratorFullName": "Craig Example",
    "creationDate": "2024-06-12T07:55:43.077+00:00",
    "eventTags": {
      "collaborator-id": "239df2bb-2189-4cba-81cc-481f07c7ba35",
      "collaborator-email": "bob.example@example.com",
      "collaborator-name": "Bob Example",
      "collaborator-project-role": "COLLABORATOR",
      "task-role": "COMMENTER",
      "task-status": "UPCOMING",
      "task-id": "9a6e6bfa-212f-434d-bc9b-54d396c9fc3a"
    },
    "eventType": "TASK_ROLE_CHANGE",
    "status": "SUCCESS"
  }

ANCHOR_CREATION
Click to expand...

  {
    "id": "75270a74-dde4-4e93-b1f1-ed5511c4e9ae",
    "collaboratorId": "4efec053-8bee-48ce-8b00-11ac47029894",
    "collaboratorEmail": "craig.example@example.com",
    "collaboratorFullName": "Craig Example",
    "creationDate": "2024-06-11T12:03:41.932+00:00",
    "eventTags": {
      "anchor-id": "e5808db6-d418-466f-b748-931a65ef4f24"
    },
    "eventType": "ANCHOR_CREATION",
    "status": "SUCCESS"
  }

ANCHOR_DELETION
Click to expand...

  {
    "id": "c1f36475-3909-4ecd-99ef-466d5b2d268e",
    "collaboratorId": "4efec053-8bee-48ce-8b00-11ac47029894",
    "collaboratorEmail": "craig.example@example.com",
    "collaboratorFullName": "Craig Example",
    "creationDate": "2024-06-12T07:59:52.839+00:00",
    "eventTags": {
      "anchor-id": "8bf2babc-9582-4fc0-9820-f2434c1b2993"
    },
    "eventType": "ANCHOR_DELETION",
    "status": "SUCCESS"
  }

ANCHOR_ATTACH_DOCUMENT
Click to expand...

  {
    "id": "341423de-ecdd-4e0b-9611-a695f81007fa",
    "collaboratorId": "4efec053-8bee-48ce-8b00-11ac47029894",
    "collaboratorEmail": "craig.example@example.com",
    "collaboratorFullName": "Craig Example",
    "creationDate": "2024-06-12T07:58:57.551+00:00",
    "eventTags": {
      "anchor-id": "8bf2babc-9582-4fc0-9820-f2434c1b2993",
      "anchor-document": "bigco_template_2020.docx"
    },
    "eventType": "ANCHOR_ATTACH_DOCUMENT",
    "status": "SUCCESS"
  }

ANCHOR_DETACH_DOCUMENT
Click to expand...

  {
    "id": "17e23632-a519-4b8d-a65e-f5e6a4f544fc",
    "collaboratorId": "4efec053-8bee-48ce-8b00-11ac47029894",
    "collaboratorEmail": "craig.example@example.com",
    "collaboratorFullName": "Craig Example",
    "creationDate": "2024-06-12T07:59:21.227+00:00",
    "eventTags": {
      "anchor-id": "8bf2babc-9582-4fc0-9820-f2434c1b2993",
      "anchor-document": "bigco_template_2020.docx"
    },
    "eventType": "ANCHOR_DETACH_DOCUMENT",
    "status": "SUCCESS"
  }