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",
"email": "john.doe@example.com"
}
}
}
File events (
workspace.file.downloaded, workspace.file.viewed,
workspace.file_widget.file.uploaded, workspace.plan.task.action.file.*,
and workspace.plan.task.file.uploaded) include a file object in
associatedObjects with a short-lived presigned download url. The URL expires
at expiresAt (one hour); re-fetch the event or generate a new link if it has
expired.Workspace-level events
These events are triggered in the context of your entire workspace:Workspace createdWorkspace viewedWorkspace plan task createdWorkspace plan task title changedWorkspace plan task description changedWorkspace plan task status changedWorkspace plan task completedWorkspace plan task uncompletedWorkspace plan task deletedWorkspace plan task due date changedWorkspace plan task comment createdWorkspace plan task assignee addedWorkspace plan task assignee removedWorkspace plan task action link clickedWorkspace plan task action file downloadedWorkspace plan task action file uploadedWorkspace plan task action pdf viewedWorkspace plan task action video viewedWorkspace plan task action form interactedWorkspace plan task action calendar interactedWorkspace plan task action embed interactedWorkspace plan task action custom code embed interactedWorkspace plan task file uploadedWorkspace comment createdWorkspace comment editedWorkspace comment deletedWorkspace embed interactedWorkspace custom code interactedWorkspace file downloadedWorkspace file viewedWorkspace message createdWorkspace message commentedWorkspace security profile document downloadedWorkspace security profile document viewedWorkspace security profile document link clickedWorkspace order form signedWorkspace order form fully signedWorkspace order form viewedWorkspace order form downloadedWorkspace NDA signedWorkspace link clickedWorkspace text link clickedWorkspace page viewedWorkspace section navigation clickedWorkspace file widget file uploadedWorkspace form submitted
Workspace created
This event is triggered when a workspace is created. Here’s an example payload:Sample payload
Sample payload
workspace.created
{
"id": "SI5UTJ7dqKoQ",
"object": "webhook-event",
"webhookId": "MTmjIOBDZAI9",
"subscriptionId": "LPovP9OvQoZi",
"subscriptionType": "workspace.created",
"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",
"email": "john.doe@example.com"
}
}
}
Workspace viewed
This event is triggered when a workspace is viewed. Here’s an example payload:Sample 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",
"email": "john.doe@example.com"
}
},
}
Workspace plan task created
This event is triggered when a workspace plan task is created. Here’s an example payload:Sample payload
Sample payload
workspace.plan.task.created
{
"id": "SI5UTJ7dqKoQ",
"object": "webhook-event",
"webhookId": "MTmjIOBDZAI9",
"subscriptionId": "LPovP9OvQoZi",
"subscriptionType": "workspace.plan.task.created",
"occurredAt": "2025-01-28T20:54:43.412Z",
"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",
"email": "john.doe@example.com"
},
"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
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",
"email": "john.doe@example.com"
},
"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 description changed
This event is triggered when a workspace plan task description is changed. Here’s an example payload:Sample payload
Sample payload
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",
"email": "john.doe@example.com"
},
"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
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",
"email": "john.doe@example.com"
},
"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
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",
"email": "john.doe@example.com"
},
"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
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",
"email": "john.doe@example.com"
},
"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
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",
"email": "john.doe@example.com"
},
"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
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",
"email": "john.doe@example.com"
},
"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 comment created
This event is triggered when a workspace plan task comment is created. Here’s an example payload:Sample payload
Sample payload
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",
"email": "john.doe@example.com"
},
"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 added
This event is triggered when a workspace plan task assignee is added. Here’s an example payload:Sample payload
Sample payload
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",
"email": "john.doe@example.com"
},
"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
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",
"email": "john.doe@example.com"
},
"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
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",
"email": "john.doe@example.com"
},
"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
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",
"email": "john.doe@example.com"
},
"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 uploaded
This event is triggered when a file is uploaded to a workspace plan task action. Here’s an example payload:Sample payload
Sample payload
workspace.plan.task.action.file.uploaded
{
"id": "SI5UTJ7dqKoQ",
"object": "webhook-event",
"webhookId": "MTmjIOBDZAI9",
"subscriptionId": "LPovP9OvQoZi",
"subscriptionType": "workspace.plan.task.action.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",
"email": "john.doe@example.com"
},
"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"
},
"file": {
"id": "fL4mN6oP8qRs",
"object": "file",
"name": "proposal.pdf",
"url": "https://storage.googleapis.com/dock-production-private/...signed...",
"expiresAt": "2025-01-28T21:54:43.412Z"
}
}
}
Workspace plan task action pdf viewed
This event is triggered when a PDF in a workspace plan task action is viewed. Here’s an example payload:Sample payload
Sample payload
workspace.plan.task.action.pdf.viewed
{
"id": "SI5UTJ7dqKoQ",
"object": "webhook-event",
"webhookId": "MTmjIOBDZAI9",
"subscriptionId": "LPovP9OvQoZi",
"subscriptionType": "workspace.plan.task.action.pdf.viewed",
"occurredAt": "2025-01-28T20:54:43.412Z",
"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",
"email": "john.doe@example.com"
},
"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 video viewed
This event is triggered when a video in a workspace plan task action is viewed. Here’s an example payload:Sample payload
Sample payload
workspace.plan.task.action.video.viewed
{
"id": "SI5UTJ7dqKoQ",
"object": "webhook-event",
"webhookId": "MTmjIOBDZAI9",
"subscriptionId": "LPovP9OvQoZi",
"subscriptionType": "workspace.plan.task.action.video.viewed",
"occurredAt": "2025-01-28T20:54:43.412Z",
"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",
"email": "john.doe@example.com"
},
"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 form interacted
This event is triggered when a form in a workspace plan task action is interacted with. Here’s an example payload:Sample payload
Sample payload
workspace.plan.task.action.form.interacted
{
"id": "SI5UTJ7dqKoQ",
"object": "webhook-event",
"webhookId": "MTmjIOBDZAI9",
"subscriptionId": "LPovP9OvQoZi",
"subscriptionType": "workspace.plan.task.action.form.interacted",
"occurredAt": "2025-01-28T20:54:43.412Z",
"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",
"email": "john.doe@example.com"
},
"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 calendar interacted
This event is triggered when a calendar in a workspace plan task action is interacted with. Here’s an example payload:Sample payload
Sample payload
workspace.plan.task.action.calendar.interacted
{
"id": "SI5UTJ7dqKoQ",
"object": "webhook-event",
"webhookId": "MTmjIOBDZAI9",
"subscriptionId": "LPovP9OvQoZi",
"subscriptionType": "workspace.plan.task.action.calendar.interacted",
"occurredAt": "2025-01-28T20:54:43.412Z",
"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",
"email": "john.doe@example.com"
},
"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 embed interacted
This event is triggered when an embed in a workspace plan task action is interacted with. Here’s an example payload:Sample payload
Sample payload
workspace.plan.task.action.embed.interacted
{
"id": "SI5UTJ7dqKoQ",
"object": "webhook-event",
"webhookId": "MTmjIOBDZAI9",
"subscriptionId": "LPovP9OvQoZi",
"subscriptionType": "workspace.plan.task.action.embed.interacted",
"occurredAt": "2025-01-28T20:54:43.412Z",
"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",
"email": "john.doe@example.com"
},
"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 custom code embed interacted
This event is triggered when a custom code embed in a workspace plan task action is interacted with. Here’s an example payload:Sample payload
Sample payload
workspace.plan.task.action.custom_code_embed.interacted
{
"id": "SI5UTJ7dqKoQ",
"object": "webhook-event",
"webhookId": "MTmjIOBDZAI9",
"subscriptionId": "LPovP9OvQoZi",
"subscriptionType": "workspace.plan.task.action.custom_code_embed.interacted",
"occurredAt": "2025-01-28T20:54:43.412Z",
"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",
"email": "john.doe@example.com"
},
"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 file uploaded
This event is triggered when a file is uploaded via the file manager inside a plan/task description. The payload includes afile object with a short-lived
presigned download URL.
Sample payload
Sample payload
workspace.plan.task.file.uploaded
{
"id": "SI5UTJ7dqKoQ",
"object": "webhook-event",
"webhookId": "MTmjIOBDZAI9",
"subscriptionId": "LPovP9OvQoZi",
"subscriptionType": "workspace.plan.task.file.uploaded",
"occurredAt": "2025-01-28T20:54:43.412Z",
"propertyName": "name",
"propertyPreviousValue": null,
"propertyValue": "proposal.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",
"email": "john.doe@example.com"
},
"workspacePlanTask": {
"id": "XycKxQP2Zfva",
"object": "workspace-plan-task",
"url": "https://api.dock.us/v1/workspace-plan-tasks/XycKxQP2Zfva",
"title": "Task title",
"templatePlanTaskId": "R6EfdsZwWuKc"
},
"workspacePlan": {
"id": "751gZMeRAScD",
"object": "workspace-plan",
"url": "https://api.dock.us/v1/workspace-plans/751gZMeRAScD",
"title": "Plan title"
},
"file": {
"id": "fL4mN6oP8qRs",
"object": "file",
"name": "proposal.pdf",
"url": "https://storage.googleapis.com/dock-production-private/...signed...",
"expiresAt": "2025-01-28T21:54:43.412Z"
}
}
}
Workspace comment created
This event is triggered when a workspace comment is created. Here’s an example payload:Sample 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",
"email": "john.doe@example.com"
}
}
}
Workspace comment edited
This event is triggered when a workspace comment is edited. Here’s an example payload:Sample payload
Sample payload
workspace.comment.edited
{
"id": "SI5UTJ7dqKoQ",
"object": "webhook-event",
"webhookId": "MTmjIOBDZAI9",
"subscriptionId": "LPovP9OvQoZi",
"subscriptionType": "workspace.comment.edited",
"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",
"email": "john.doe@example.com"
}
}
}
Workspace comment deleted
This event is triggered when a workspace comment is deleted. Here’s an example payload:Sample payload
Sample payload
workspace.comment.deleted
{
"id": "SI5UTJ7dqKoQ",
"object": "webhook-event",
"webhookId": "MTmjIOBDZAI9",
"subscriptionId": "LPovP9OvQoZi",
"subscriptionType": "workspace.comment.deleted",
"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",
"email": "john.doe@example.com"
}
}
}
Workspace embed interacted
This event is triggered when a workspace embed is interacted with. Here’s an example payload:Sample 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",
"email": "john.doe@example.com"
},
"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
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",
"email": "john.doe@example.com"
},
"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
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",
"email": "john.doe@example.com"
},
"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
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",
"email": "john.doe@example.com"
},
"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
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",
"email": "john.doe@example.com"
}
}
}
Workspace message commented
This event is triggered when a workspace message is commented on. Here’s an example payload:Sample payload
Sample payload
workspace.message.comment.created
{
"id": "SI5UTJ7dqKoQ",
"object": "webhook-event",
"webhookId": "MTmjIOBDZAI9",
"subscriptionId": "LPovP9OvQoZi",
"subscriptionType": "workspace.message.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",
"email": "john.doe@example.com"
}
}
}
Workspace security profile document downloaded
This event is triggered when a workspace security profile document is downloaded. Here’s an example payload:Sample 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",
"email": "john.doe@example.com"
},
"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
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",
"email": "john.doe@example.com"
},
"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
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",
"email": "john.doe@example.com"
},
"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
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",
"email": "john.doe@example.com"
},
"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
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",
"email": "john.doe@example.com"
},
"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
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",
"email": "john.doe@example.com"
},
"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
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",
"email": "john.doe@example.com"
},
"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
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",
"email": "john.doe@example.com"
},
"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 link clicked
Sample payload
Sample payload
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",
"email": "john.doe@example.com"
},
"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
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",
"email": "john.doe@example.com"
},
"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
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",
"email": "john.doe@example.com"
},
"workspacePage": {
"id": "ShCzALeE7ZRj",
"object": "workspace-page",
"url": "https://api.dock.us/v1/workspace-pages/ShCzALeE7ZRj",
"templatePageId": "f6lAhd09H9au"
}
}
}
Workspace section navigation clicked
This event is triggered when a workspace section navigation is clicked. Here’s an example payload:Sample 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",
"email": "john.doe@example.com"
},
"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 widget file uploaded
This event is triggered when a file is uploaded from a file widget. Here’s an example payload:Sample 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",
"email": "john.doe@example.com"
},
"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. Forfile_upload questions, each formQuestionResponses item can include an optional files array with temporary download links.
files[].url is a presigned URL and may be null if link generation fails; links expire at files[].expiresAt.
Here’s an example payload:
Sample 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"
],
"files": [
{
"id": "3EoaD0z8Y3dN",
"object": "file",
"name": "akasa.jpg",
"url": "https://storage.googleapis.com/example/signed-url",
"expiresAt": "2025-05-06T18:25:38.930Z"
}
]
},
{
"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. When the submitted question is afile_upload, associatedObjects.formQuestionResponse can also include the optional files array described above.
Here’s an example payload:
Sample 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"
}
}
}
Course events
These events are triggered when a learner completes coursework in a workspace-linked course.Course completed
This event is triggered when a learner reaches the course completion state.Sample payload
Sample payload
course.completed
{
"id": "SI5UTJ7dqKoQ",
"object": "webhook-event",
"webhookId": "MTmjIOBDZAI9",
"subscriptionId": "LPovP9OvQoZi",
"subscriptionType": "course.completed",
"occurredAt": "2025-01-28T20:54:43.412Z",
"propertyName": "status",
"propertyPreviousValue": "inProgress",
"propertyValue": "completed",
"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",
"email": "john.doe@example.com",
"name": "John Doe",
"firstName": "John",
"lastName": "Doe"
},
"learner": {
"id": "bN0pQ2rT5uVw",
"object": "learner",
"url": "https://api.dock.us/v1/users/bN0pQ2rT5uVw",
"email": "learner@example.com",
"name": "Jordan Lee",
"firstName": "Jordan",
"lastName": "Lee"
},
"reviewer": {
"id": "cQ1rS3tUvWx",
"object": "reviewer",
"url": "https://api.dock.us/v1/users/cQ1rS3tUvWx",
"email": "reviewer@example.com",
"name": "Sam Rivera",
"firstName": "Sam",
"lastName": "Rivera"
},
"course": {
"id": "dR2sT4uVwXy",
"object": "course",
"url": "https://api.dock.us/v1/courses/dR2sT4uVwXy",
"name": "Security Onboarding"
},
"assignment": {
"id": "eS3tU5vWxYz",
"object": "assignment",
"url": "https://api.dock.us/v1/course-assignments/eS3tU5vWxYz",
"status": "completed",
"dueDate": "2026-07-01T00:00:00.000Z",
"completedAt": "2026-06-26T00:00:00.000Z",
"scoreObtained": 9,
"totalScore": 10
}
}
}
Course reviewed
This event is triggered when a reviewer finalizes the course review state.Sample payload
Sample payload
course.reviewed
{
"id": "SI5UTJ7dqKoQ",
"object": "webhook-event",
"webhookId": "MTmjIOBDZAI9",
"subscriptionId": "LPovP9OvQoZi",
"subscriptionType": "course.reviewed",
"occurredAt": "2025-01-28T20:54:43.412Z",
"propertyName": "status",
"propertyPreviousValue": "readyForReview",
"propertyValue": "completed",
"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",
"email": "reviewer@example.com",
"name": "Sam Rivera",
"firstName": "Sam",
"lastName": "Rivera"
},
"learner": {
"id": "bN0pQ2rT5uVw",
"object": "learner",
"url": "https://api.dock.us/v1/users/bN0pQ2rT5uVw",
"email": "learner@example.com",
"name": "Jordan Lee",
"firstName": "Jordan",
"lastName": "Lee"
},
"reviewer": {
"id": "cQ1rS3tUvWx",
"object": "reviewer",
"url": "https://api.dock.us/v1/users/cQ1rS3tUvWx",
"email": "reviewer@example.com",
"name": "Sam Rivera",
"firstName": "Sam",
"lastName": "Rivera"
},
"course": {
"id": "dR2sT4uVwXy",
"object": "course",
"url": "https://api.dock.us/v1/courses/dR2sT4uVwXy",
"name": "Security Onboarding"
},
"assignment": {
"id": "eS3tU5vWxYz",
"object": "assignment",
"url": "https://api.dock.us/v1/course-assignments/eS3tU5vWxYz",
"status": "completed",
"dueDate": "2026-07-01T00:00:00.000Z",
"completedAt": "2026-06-26T00:00:00.000Z",
"scoreObtained": 9,
"totalScore": 10
}
}
}
Presentation events
These events are triggered for presentation share-link activity only. Internal workspace presentation views/downloads are not emitted as these webhook event types.Presentation viewed
This event is triggered when a presentation is viewed through a share link.Sample payload
Sample payload
presentation.viewed
{
"id": "SI5UTJ7dqKoQ",
"object": "webhook-event",
"webhookId": "MTmjIOBDZAI9",
"subscriptionId": "LPovP9OvQoZi",
"subscriptionType": "presentation.viewed",
"occurredAt": "2025-01-28T20:54:43.412Z",
"associatedObjects": {
"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",
"email": "john.doe@example.com"
},
"presentation": {
"id": "pRe5enT8tioN",
"object": "presentation",
"name": "Q3 Pitch Deck"
},
"owners": [
{
"id": "gT5uH7iJ9kLm",
"object": "owner",
"url": "https://api.dock.us/v1/users/gT5uH7iJ9kLm",
"email": "owner@example.com",
"name": "Alex Kim",
"firstName": "Alex",
"lastName": "Kim"
}
]
}
}
The top-level
propertyName / propertyValue / propertyPreviousValue fields
are only present when an event represents a property change. Events with no
property change (e.g. presentation.viewed, presentation.shared) omit them.
account is included only when an account is linked to the presentation;
owners only when the presentation has owners.Presentation downloaded
This event is triggered when a presentation file is downloaded through a share link.Sample payload
Sample payload
presentation.downloaded
{
"id": "SI5UTJ7dqKoQ",
"object": "webhook-event",
"webhookId": "MTmjIOBDZAI9",
"subscriptionId": "LPovP9OvQoZi",
"subscriptionType": "presentation.downloaded",
"occurredAt": "2025-01-28T20:54:43.412Z",
"propertyName": "fileType",
"propertyPreviousValue": null,
"propertyValue": "pdf",
"associatedObjects": {
"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",
"email": "john.doe@example.com"
},
"presentation": {
"id": "pRe5enT8tioN",
"object": "presentation",
"name": "Q3 Pitch Deck"
}
}
}
Presentation shared
This event is triggered when a presentation share link is created — for both tracking and non-tracking links. Whether the link is a tracking (gated) link is exposed asisTracking on the presentation associated object.
Sample payload
Sample payload
presentation.shared
{
"id": "SI5UTJ7dqKoQ",
"object": "webhook-event",
"webhookId": "MTmjIOBDZAI9",
"subscriptionId": "LPovP9OvQoZi",
"subscriptionType": "presentation.shared",
"occurredAt": "2025-01-28T20:54:43.412Z",
"associatedObjects": {
"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",
"email": "john.doe@example.com"
},
"presentation": {
"id": "pRe5enT8tioN",
"object": "presentation",
"name": "Q3 Pitch Deck",
"isTracking": true
},
"owners": [
{
"id": "gT5uH7iJ9kLm",
"object": "owner",
"url": "https://api.dock.us/v1/users/gT5uH7iJ9kLm",
"email": "owner@example.com",
"name": "Alex Kim",
"firstName": "Alex",
"lastName": "Kim"
}
]
}
}