Dock Webhook Reference

Webhooks are a great way to get real-time notifications on events that happen in your Dock workspace. Webhooks on Dock follow the following format:

webhook-payload.json

{
  "id": "SI5UTJ7dqKoQ", // Event ID
  "object": "webhook-event", // Event type
  "webhookId": "MTmjIOBDZAI9", // Webhook ID
  "subscriptionType": "workspace.viewed", // Subscription type
  "subscriptionId": "LPovP9OvQoZi", // Subscription ID
  "occurredAt": "2024-08-30T09:53:50.343Z", // Timestamp of when the event was created
  "propertyName": null, // Name of the property that changed (if any)
  "propertyPreviousValue": null, // The previous value of the property (if any)
  "propertyValue": null,
  "associatedObjects": {
    // Associated objects
    "workspace": {
      "id": "BfkPI6fgyXQI",
      "object": "workspace",
      "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
      "templateId": "NNV2AWnp6AxY"
    },
    "account": {
      "id": "uUsnaBrnTV6N",
      "object": "account",
      "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
    },
    "user": {
      "id": "6bxK1Cyh88EK",
      "object": "user",
      "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
    }
  }
}

These are the types of events you can listen to:

Workspace-level events

Workspace-level events

These events are triggered in the context of your entire workspace:

Workspace viewed
Workspace plan task created
Workspace plan task title changed
Workspace plan task description changed
Workspace plan task status changed
Workspace plan task completed
Workspace plan task uncompleted
Workspace plan task deleted
Workspace plan task due date changed
Workspace plan task comment created
Workspace plan task assignee added
Workspace plan task assignee removed
Workspace plan task action link clicked
Workspace plan task action file downloaded
Workspace comment created
Workspace embed interacted
Workspace custom code interacted
Workspace file downloaded
Workspace file viewed
Workspace message created
Workspace message commented
Workspace security profile document downloaded
Workspace security profile document viewed
Workspace security profile document link clicked
Workspace order form signed
Workspace order form fully signed
Workspace order form viewed
Workspace order form downloaded
Workspace NDA signed
Workspace link clicked
Workspace text link clicked
Workspace page viewed
Workspace section navigation clicked
Workspace file widget file uploaded
Workspace form submitted

Workspace viewed

This event is triggered when a workspace is viewed. Here’s an example payload:

Sample payload

workspace.viewed

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.viewed",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": null,
    "propertyPreviousValue": null,
    "propertyValue": null,
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        }
    },
    
}

Workspace plan task created

This event is triggered when a workspace plan task is created. Here’s an example payload:

Sample payload

workspace.plan.task.created

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": null,
    "propertyPreviousValue": null,
    "propertyValue": null,
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspacePlanTask": {
            "id": "XycKxQP2Zfva",
            "object": "workspace-plan-task",
            "url": "https://api.dock.us/v1/workspace-plan-tasks/XycKxQP2Zfva",
            "templatePlanStepId": "R6EfdsZwWuKc"
        },
        "workspacePlan": {
            "id": "751gZMeRAScD",
            "object": "workspace-plan",
            "url": "https://api.dock.us/v1/workspace-plans/751gZMeRAScD"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        }
    },
}

Workspace plan task title changed

This event is triggered when a workspace plan task title is changed. Here’s an example payload:

Sample payload

workspace.plan.task.title.changed

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.plan.task.title.changed",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "title",
    "propertyPreviousValue": "Old title",
    "propertyValue": "New title",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspacePlanTask": {
            "id": "XycKxQP2Zfva",
            "object": "workspace-plan-task",
            "url": "https://api.dock.us/v1/workspace-plan-tasks/XycKxQP2Zfva",
            "templatePlanStepId": "R6EfdsZwWuKc"
        },
        "workspacePlan": {
            "id": "751gZMeRAScD",
            "object": "workspace-plan",
            "url": "https://api.dock.us/v1/workspace-plans/751gZMeRAScD"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        }
    },

}

</Accordion>

### Workspace plan task description changed

This event is triggered when a workspace plan task description is changed.

Here’s an example payload:

<Accordion title="Sample payload">
```json workspace.plan.task.description.changed
{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.plan.task.description.changed"
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "description",
    "propertyPreviousValue": "Old description",
    "propertyValue": "New description",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspacePlanTask": {
            "id": "XycKxQP2Zfva",
            "object": "workspace-plan-task",
            "url": "https://api.dock.us/v1/workspace-plan-tasks/XycKxQP2Zfva",
            "templatePlanStepId": "R6EfdsZwWuKc"
        },
        "workspacePlan": {
            "id": "751gZMeRAScD",
            "object": "workspace-plan",
            "url": "https://api.dock.us/v1/workspace-plans/751gZMeRAScD"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        }
    },
}

Workspace plan task status changed

This event is triggered when a workspace plan task status is changed. Here’s an example payload:

Sample payload

workspace.plan.task.status.changed

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.plan.task.status.changed",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "status",
    "propertyPreviousValue": "To do",
    "propertyValue": "In progress",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspacePlanTask": {
            "id": "XycKxQP2Zfva",
            "object": "workspace-plan-task",
            "url": "https://api.dock.us/v1/workspace-plan-tasks/XycKxQP2Zfva",
            "templatePlanStepId": "R6EfdsZwWuKc"
        },
        "workspacePlan": {
            "id": "751gZMeRAScD",
            "object": "workspace-plan",
            "url": "https://api.dock.us/v1/workspace-plans/751gZMeRAScD"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        }
    },
}

Workspace plan task completed

This event is triggered when a workspace plan task is completed. Here’s an example payload:

Sample payload

workspace.plan.task.completed

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.plan.task.completed",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": null,
    "propertyPreviousValue": null,
    "propertyValue": null,
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspacePlanTask": {
            "id": "XycKxQP2Zfva",
            "object": "workspace-plan-task",
            "url": "https://api.dock.us/v1/workspace-plan-tasks/XycKxQP2Zfva",
            "templatePlanStepId": "R6EfdsZwWuKc"
        },
        "workspacePlan": {
            "id": "751gZMeRAScD",
            "object": "workspace-plan",
            "url": "https://api.dock.us/v1/workspace-plans/751gZMeRAScD"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        }
    },
}

Workspace plan task uncompleted

This event is triggered when a workspace plan task is uncompleted. Here’s an example payload:

Sample payload

workspace.plan.task.uncompleted

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.plan.task.uncompleted",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": null,
    "propertyPreviousValue": null,
    "propertyValue": null,
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspacePlanTask": {
            "id": "XycKxQP2Zfva",
            "object": "workspace-plan-task",
            "url": "https://api.dock.us/v1/workspace-plan-tasks/XycKxQP2Zfva",
            "templatePlanStepId": "R6EfdsZwWuKc"
        },
        "workspacePlan": {
            "id": "751gZMeRAScD",
            "object": "workspace-plan",
            "url": "https://api.dock.us/v1/workspace-plans/751gZMeRAScD"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        }
    }
}

Workspace plan task deleted

This event is triggered when a workspace plan task is deleted. Here’s an example payload:

Sample payload

workspace.plan.task.deleted

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.plan.task.deleted",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": null,
    "propertyPreviousValue": null,
    "propertyValue": null,
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspacePlanTask": {
            "id": "XycKxQP2Zfva",
            "object": "workspace-plan-task",
            "url": "https://api.dock.us/v1/workspace-plan-tasks/XycKxQP2Zfva",
            "templatePlanStepId": "R6EfdsZwWuKc"
        },
        "workspacePlan": {
            "id": "751gZMeRAScD",
            "object": "workspace-plan",
            "url": "https://api.dock.us/v1/workspace-plans/751gZMeRAScD"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        }
    }
}

Workspace plan task due date changed

This event is triggered when a workspace plan task due date is changed. Here’s an example payload:

Sample payload

workspace.plan.task.due.date.changed

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.plan.task.due.date.changed",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "dueDate",
    "propertyPreviousValue": "2025-01-27",
    "propertyValue": "2025-01-28",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspacePlanTask": {
            "id": "XycKxQP2Zfva",
            "object": "workspace-plan-task",
            "url": "https://api.dock.us/v1/workspace-plan-tasks/XycKxQP2Zfva",
            "templatePlanStepId": "R6EfdsZwWuKc"
        },
        "workspacePlan": {
            "id": "751gZMeRAScD",
            "object": "workspace-plan",
            "url": "https://api.dock.us/v1/workspace-plans/751gZMeRAScD"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        }
    }
}

</Accordion>

### Workspace plan task comment created

This event is triggered when a workspace plan task comment is created.

Here’s an example payload:

<Accordion title="Sample payload">
```json workspace.plan.task.comment.created
{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.plan.task.comment.created",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "comment",
    "propertyPreviousValue": null,
    "propertyValue": "This is a comment",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspacePlanTask": {
            "id": "XycKxQP2Zfva",
            "object": "workspace-plan-task",
            "url": "https://api.dock.us/v1/workspace-plan-tasks/XycKxQP2Zfva",
            "templatePlanStepId": "R6EfdsZwWuKc"
        },
        "workspacePlan": {
            "id": "751gZMeRAScD",
            "object": "workspace-plan",
            "url": "https://api.dock.us/v1/workspace-plans/751gZMeRAScD"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        }
    }
}

 </Accordion>

### Workspace plan task assignee added

This event is triggered when a workspace plan task assignee is added.

Here’s an example payload:

<Accordion title="Sample payload">
```json workspace.plan.task.assignee.added
{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.plan.task.assignee.added"
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "name",
    "propertyPreviousValue": null,
    "propertyValue": "John Doe",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspacePlanTask": {
            "id": "XycKxQP2Zfva",
            "object": "workspace-plan-task",
            "url": "https://api.dock.us/v1/workspace-plan-tasks/XycKxQP2Zfva",
            "templatePlanStepId": "R6EfdsZwWuKc"
        },
        "workspacePlan": {
            "id": "751gZMeRAScD",
            "object": "workspace-plan",
            "url": "https://api.dock.us/v1/workspace-plans/751gZMeRAScD"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        }
    }
}

Workspace plan task assignee removed

This event is triggered when a workspace plan task assignee is removed. Here’s an example payload:

Sample payload

workspace.plan.task.assignee.removed

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.plan.task.assignee.removed",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "name",
    "propertyPreviousValue": "John Doe",
    "propertyValue": null,
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspacePlanTask": {
            "id": "XycKxQP2Zfva",
            "object": "workspace-plan-task",
            "url": "https://api.dock.us/v1/workspace-plan-tasks/XycKxQP2Zfva",
            "templatePlanStepId": "R6EfdsZwWuKc"
        },
        "workspacePlan": {
            "id": "751gZMeRAScD",
            "object": "workspace-plan",
            "url": "https://api.dock.us/v1/workspace-plans/751gZMeRAScD"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        }
    }
}

Workspace plan task action link clicked

This event is triggered when a workspace plan task action link is clicked. Here’s an example payload:

Sample payload

workspace.plan.task.action.link.clicked

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.plan.task.action.link.clicked",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "url",
    "propertyPreviousValue": null,
    "propertyValue": "https://dock.us",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspacePlanTask": {
            "id": "XycKxQP2Zfva",
            "object": "workspace-plan-task",
            "url": "https://api.dock.us/v1/workspace-plan-tasks/XycKxQP2Zfva",
            "templatePlanStepId": "R6EfdsZwWuKc"
        },
        "workspacePlan": {
            "id": "751gZMeRAScD",
            "object": "workspace-plan",
            "url": "https://api.dock.us/v1/workspace-plans/751gZMeRAScD"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        }
    }
}

Workspace plan task action file downloaded

This event is triggered when a workspace plan task action file is downloaded. Here’s an example payload:

Sample payload

workspace.plan.task.action.file.downloaded

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.plan.task.action.file.downloaded",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "name",
    "propertyPreviousValue": null,
    "propertyValue": "file.pdf",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspacePlanTask": {
            "id": "XycKxQP2Zfva",
            "object": "workspace-plan-task",
            "url": "https://api.dock.us/v1/workspace-plan-tasks/XycKxQP2Zfva",
            "templatePlanStepId": "R6EfdsZwWuKc"
        },
        "workspacePlan": {
            "id": "751gZMeRAScD",
            "object": "workspace-plan",
            "url": "https://api.dock.us/v1/workspace-plans/751gZMeRAScD"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        }
    }
}

Workspace comment created

This event is triggered when a workspace comment is created. Here’s an example payload:

Sample payload

workspace.comment.created

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.comment.created"
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "comment",
    "propertyPreviousValue": null,
    "propertyValue": "This is a comment",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        }
    },
}

Workspace embed interacted

This event is triggered when a workspace embed is interacted with. Here’s an example payload:

Sample payload

workspace.embed.interacted

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.embed.interacted",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "url",
    "propertyPreviousValue": null,
    "propertyValue": "https://dock.us",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        }
    }
}

Workspace custom code interacted

This event is triggered when a workspace custom code is interacted with. Here’s an example payload:

Sample payload

workspace.custom.code.interacted

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.custom_code.interacted",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "code",
    "propertyPreviousValue": null,
    "propertyValue": "console.log(\"Hello, world!\");",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        }
    }
}

Workspace file downloaded

This event is triggered when a workspace file is downloaded. Here’s an example payload:

Sample payload

workspace.file.downloaded

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.file.downloaded",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "name",
    "propertyPreviousValue": null,
    "propertyValue": "file.pdf",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        }
    }
}

Workspace file viewed

This event is triggered when a workspace file is viewed. Here’s an example payload:

Sample payload

workspace.file.viewed

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.file.viewed",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "name",
    "propertyPreviousValue": null,
    "propertyValue": "file.pdf",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        }
    }
}

Workspace message created

This event is triggered when a workspace message is created. Here’s an example payload:

Sample payload

workspace.message.created

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.message.created",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "messageBody",
    "propertyPreviousValue": null,
    "propertyValue": "This is a message",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        }
    }
}

Workspace message commented

This event is triggered when a workspace message is commented on. Here’s an example payload:

Sample payload

workspace.message.commented

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.message.commented",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "comment",
    "propertyPreviousValue": null,
    "propertyValue": "This is a comment",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        }
    }
}

Workspace security profile document downloaded

This event is triggered when a workspace security profile document is downloaded. Here’s an example payload:

Sample payload

workspace.security_profile_document.downloaded

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.security_profile_document.downloaded",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "name",
    "propertyPreviousValue": null,
    "propertyValue": "file.pdf",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        }
    }
}

Workspace security profile document viewed

This event is triggered when a workspace security profile document is viewed. Here’s an example payload:

Sample payload

workspace.security_profile_document.viewed

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.security_profile_document.viewed",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "name",
    "propertyPreviousValue": null,
    "propertyValue": "file.pdf",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        }
    },
}

Workspace security profile document link clicked

This event is triggered when a workspace security profile document link is clicked. Here’s an example payload:

Sample payload

workspace.security_profile_document.link.clicked

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.security_profile_document.link.clicked",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "url",
    "propertyPreviousValue": null,
    "propertyValue": "https://dock.us",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        }
    }
}

Workspace order form signed

This event is triggered when a workspace order form is signed. Here’s an example payload:

Sample payload

workspace.order_form.signed

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.order_form.signed",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "title",
    "propertyPreviousValue": null,
    "propertyValue": "Order Form",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        }
    }
}

Workspace order form fully signed

This event is triggered when a workspace order form is fully signed. Here’s an example payload:

Sample payload

workspace.order_form.fully_signed

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.order_form.fully_signed",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "title",
    "propertyPreviousValue": null,
    "propertyValue": "Order Form",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        }
    }
}

Workspace order form viewed

This event is triggered when a workspace order form is viewed. Here’s an example payload:

Sample payload

workspace.order_form.viewed

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.order_form.viewed",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "title",
    "propertyPreviousValue": null,
    "propertyValue": "Order Form",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        }
    }
}

Workspace order form downloaded

This event is triggered when a workspace order form is downloaded. Here’s an example payload:

Sample payload

workspace.order_form.downloaded

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.order_form.downloaded",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "title",
    "propertyPreviousValue": null,
    "propertyValue": "Order Form",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        }
    }
}

Workspace NDA signed

This event is triggered when a workspace NDA is signed. Here’s an example payload:

Sample payload

workspace.nda.signed

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.nda.signed",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "name",
    "propertyPreviousValue": null,
    "propertyValue": "Workspace NDA",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        }
    }
}
```</Accordion>

### Workspace link clicked

<Accordion title="Sample payload">
```json workspace.link.clicked
{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.link.clicked",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "url",
    "propertyPreviousValue": null,
    "propertyValue": "https://dock.us",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        }
    }
}

Workspace text link clicked

This event is triggered when a workspace text link is clicked. Here’s an example payload:

Sample payload

workspace.text_link.clicked

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.text_link.clicked",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "url",
    "propertyPreviousValue": null,
    "propertyValue": "https://dock.us",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        }
    }
}

Workspace page viewed

This event is triggered when a workspace page is viewed. Here’s an example payload:

Sample payload

workspace.page.viewed

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.page.viewed",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": null,
    "propertyPreviousValue": null,
    "propertyValue": null,
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        }
    }
}

This event is triggered when a workspace section navigation is clicked. Here’s an example payload:

Sample payload

workspace.section_navigation.clicked

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.section_navigation.clicked",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "name",
    "propertyPreviousValue": null,
    "propertyValue": "Section 1",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        }
    }
}

This event is triggered when a file is uploaded from a file widget. Here’s an example payload:

Sample payload

workspace.file_widget.file.uploaded

{
    "id": "SI5UTJ7dqKoQ",
    "object": "webhook-event",
    "webhookId": "MTmjIOBDZAI9",
    "subscriptionId": "LPovP9OvQoZi",
    "subscriptionType": "workspace.file_widget.file.uploaded",
    "occurredAt": "2025-01-28T20:54:43.412Z",
    "propertyName": "name",
    "propertyPreviousValue": null,
    "propertyValue": "file.pdf",
    "associatedObjects": {
        "workspace": {
            "id": "BfkPI6fgyXQI",
            "object": "workspace",
            "url": "https://api.dock.us/v1/workspaces/BfkPI6fgyXQI",
            "templateId": "NNV2AWnp6AxY"
        },
        "account": {
            "id": "uUsnaBrnTV6N",
            "object": "account",
            "url": "https://api.dock.us/v1/accounts/uUsnaBrnTV6N"
        },
        "user": {
            "id": "6bxK1Cyh88EK",
            "object": "user",
            "url": "https://api.dock.us/v1/users/6bxK1Cyh88EK"
        },
        "workspaceSection": {
            "id": "mITE6OX6b8vd",
            "object": "workspace-section",
            "url": "https://api.dock.us/v1/workspace-sections/mITE6OX6b8vd",
            "templateSectionId": "ZZnXcAAYZxL5"
        },
        "workspacePage": {
            "id": "ShCzALeE7ZRj",
            "object": "workspace-page",
            "url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
            "templatePageId": "f6lAhd09H9au"
        }
    }
}

Workspace form submitted

This event is triggered when a workspace form is submitted. Here’s an example payload:

Sample payload

workspace.form.submitted

{
  "id": "E2Q4LtRLrFqK",
  "object": "webhook-event",
  "webhookId": "2KpNX8mSPGNz",
  "subscriptionType": "workspace.form.submitted",
  "subscriptionId": "aq74qC2rzADt",
  "occurredAt": "2025-05-06T17:25:38.930Z",
  "propertyName": null,
  "propertyPreviousValue": null,
  "propertyValue": null,
  "associatedObjects": {
    "workspace": {
      "id": "b6lnIUNYBkPL",
      "object": "workspace",
      "url": "https://api.dock.us/workspaces/b6lnIUNYBkPL",
      "name": "Test webhook form"
    },
    "account": {
      "id": "o069gCV0WkQe",
      "object": "account",
      "url": "https://api.dock.us/accounts/o069gCV0WkQe",
      "hubspotCompanyId": "18639617835"
    },
    "user": {
      "id": "tzmDEEZy1bvq",
      "object": "user",
      "url": "https://api.dock.us/users/tzmDEEZy1bvq",
      "email": "test@dock.us"
    },
    "workspacePage": {
      "id": "3TGNkB8Gopo3",
      "object": "workspace-page",
      "url": "https://api.dock.us/workspace-pages/3TGNkB8Gopo3",
      "name": "Test webhook form"
    },
    "workspaceSection": {
      "id": "lVwwuS0noQQv",
      "object": "workspace-section",
      "url": "https://api.dock.us/workspace-sections/lVwwuS0noQQv",
      "name": null
    },
    "workspaceForm": {
      "id": "9NdExtsz05Fi",
      "formId": "vaQprFfsdF71",
      "object": "workspace-form",
      "title": "Test survey form "
    },
    "formQuestions": [
      {
        "id": "pN8QbxezAlja",
        "object": "form-question",
        "title": "What are the areas of your interest?",
        "type": "checkbox"
      },
      {
        "id": "ijhXFq3GCZDJ",
        "object": "form-question",
        "title": "Choose any one framework?",
        "type": "dropdown"
      },
      {
        "id": "EXC2Hni0vbsm",
        "object": "form-question",
        "title": "Fileupload Question Title",
        "type": "file_upload"
      },
      {
        "id": "TVuJd4msyAp0",
        "object": "form-question",
        "title": "Explain what the product does?",
        "type": "paragraph"
      },
      {
        "id": "T0aLHfaCkZFR",
        "object": "form-question",
        "title": "Office Address?",
        "type": "single_line"
      },
      {
        "id": "kku1qvevzwx4",
        "object": "form-question",
        "title": "Website for the product",
        "type": "url"
      },
      {
        "id": "0gMsa9Uw0Nff",
        "object": "form-question",
        "title": "Focus area of the product?",
        "type": "checkbox"
      }
    ],
    "formQuestionResponses": [
      {
        "id": "MYpTNXp1jL7I",
        "object": "form-question-response",
        "formQuestionId": "pN8QbxezAlja",
        "value": [
          "SaaS",
          "AI/ML",
          "Other answer"
        ]
      },
      {
        "id": "UiU2o7z4xHQr",
        "object": "form-question-response",
        "formQuestionId": "ijhXFq3GCZDJ",
        "value": [
          "Laravel"
        ]
      },
      {
        "id": "nVP1ce5LJI1H",
        "object": "form-question-response",
        "formQuestionId": "EXC2Hni0vbsm",
        "value": [
          "akasa.jpg"
        ]
      },
      {
        "id": "a9Pzhsyy2kKS",
        "object": "form-question-response",
        "formQuestionId": "TVuJd4msyAp0",
        "value": "Organizes all customer-shared content in one workspace.\nCreate sales rooms, onboarding plans, & client portals that delight customers.\nWith a little help from AI to write business cases, project plans, and more."
      },
      {
        "id": "hJHAE1PNCGJR",
        "object": "form-question-response",
        "formQuestionId": "T0aLHfaCkZFR",
        "value": "4, 14, Kamal Park Society, B/h Geb Office, Race Course"
      },
      {
        "id": "krVO6hdL9cZe",
        "object": "form-question-response",
        "formQuestionId": "kku1qvevzwx4",
        "value": "https://acme.com"
      },
      {
        "id": "ObwEWzdGzQGC",
        "object": "form-question-response",
        "formQuestionId": "0gMsa9Uw0Nff",
        "value": [
          "Fintech",
          "Saas"
        ]
      }
    ]
  }
}

Workspace form question submitted

This event is triggered when a workspace form is submitted. Here’s an example payload:

Sample payload

workspace.form.question.submitted

{
  "id": "E2Q4LtRLrFqK",
  "object": "webhook-event",
  "webhookId": "2KpNX8mSPGNz",
  "subscriptionType": "workspace.form.question.submitted",
  "subscriptionId": "aq74qC2rzADt",
  "occurredAt": "2025-05-06T17:25:38.930Z",
  "propertyName": "value",
  "propertyPreviousValue": null,
  "propertyValue": "SaaS, AI/ML, Other answer",
  "associatedObjects": {
    "workspace": {
      "id": "b6lnIUNYBkPL",
      "object": "workspace",
      "url": "https://api.dock.us/workspaces/b6lnIUNYBkPL",
      "name": "Test webhook form"
    },
    "account": {
      "id": "o069gCV0WkQe",
      "object": "account",
      "url": "https://api.dock.us/accounts/o069gCV0WkQe",
      "hubspotCompanyId": "18639617835"
    },
    "user": {
      "id": "tzmDEEZy1bvq",
      "object": "user",
      "url": "https://api.dock.us/users/tzmDEEZy1bvq",
      "email": "test@dock.us"
    },
    "workspacePage": {
      "id": "3TGNkB8Gopo3",
      "object": "workspace-page",
      "url": "https://api.dock.us/workspace-pages/3TGNkB8Gopo3",
      "name": "Test webhook form"
    },
    "workspaceSection": {
      "id": "lVwwuS0noQQv",
      "object": "workspace-section",
      "url": "https://api.dock.us/workspace-sections/lVwwuS0noQQv",
      "name": null
    },
    "workspaceForm": {
      "id": "9NdExtsz05Fi",
      "formId": "vaQprFfsdF71",
      "object": "workspace-form",
      "title": "Test survey form "
    },
    "formQuestion": {
        "id": "pN8QbxezAlja",
        "object": "form-question",
        "title": "What are the areas of your interest?",
        "type": "checkbox"
      },
    "formQuestionResponse": {
        "id": "MYpTNXp1jL7I",
        "object": "form-question-response",
        "formQuestionId": "pN8QbxezAlja",
        "value": "SaaS, AI/ML, Other answer"
      }
  }
}

Webhooks

​Workspace-level events

​Workspace viewed

​Workspace plan task created

​Workspace plan task title changed

​Workspace plan task status changed

​Workspace plan task completed

​Workspace plan task uncompleted

​Workspace plan task deleted

​Workspace plan task due date changed

​Workspace plan task assignee removed

​Workspace plan task action link clicked

​Workspace plan task action file downloaded

​Workspace comment created

​Workspace embed interacted

​Workspace custom code interacted

​Workspace file downloaded

​Workspace file viewed

​Workspace message created

​Workspace message commented

​Workspace security profile document downloaded

​Workspace security profile document viewed

​Workspace security profile document link clicked

​Workspace order form signed

​Workspace order form fully signed

​Workspace order form viewed

​Workspace order form downloaded

​Workspace NDA signed

​Workspace text link clicked

​Workspace page viewed

​Workspace section navigation clicked

​Workspace file widget file uploaded

​Workspace form submitted

​Workspace form question submitted

Workspace-level events

Workspace viewed

Workspace plan task created

Workspace plan task title changed

Workspace plan task status changed

Workspace plan task completed

Workspace plan task uncompleted

Workspace plan task deleted

Workspace plan task due date changed

Workspace plan task assignee removed

Workspace plan task action link clicked

Workspace plan task action file downloaded

Workspace comment created

Workspace embed interacted

Workspace custom code interacted

Workspace file downloaded

Workspace file viewed

Workspace message created

Workspace message commented

Workspace security profile document downloaded

Workspace security profile document viewed

Workspace security profile document link clicked

Workspace order form signed

Workspace order form fully signed

Workspace order form viewed

Workspace order form downloaded

Workspace NDA signed

Workspace text link clicked

Workspace page viewed

Workspace section navigation clicked

Workspace file widget file uploaded

Workspace form submitted

Workspace form question submitted