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

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

​
Workspace viewed

This event is triggered when a workspace is viewed.

Here’s an example payload:

​
Workspace plan task created

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

Here’s an example payload:

​
Workspace plan task title changed

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

Here’s an example payload:

​
Workspace plan task status changed

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

Here’s an example payload:

​
Workspace plan task completed

This event is triggered when a workspace plan task is completed.

Here’s an example payload:

​
Workspace plan task uncompleted

This event is triggered when a workspace plan task is uncompleted.

Here’s an example payload:

​
Workspace plan task deleted

This event is triggered when a workspace plan task is deleted.

Here’s an example payload:

​
Workspace plan task due date changed

This event is triggered when a workspace plan task due date is changed.

Here’s an example payload:

​
Workspace plan task assignee removed

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

Here’s an example payload:

This event is triggered when a workspace plan task action link is clicked.

Here’s an example payload:

​
Workspace plan task action file downloaded

This event is triggered when a workspace plan task action file is downloaded.

Here’s an example payload:

​
Workspace comment created

This event is triggered when a workspace comment is created.

Here’s an example payload:

​
Workspace embed interacted

This event is triggered when a workspace embed is interacted with.

Here’s an example payload:

​
Workspace custom code interacted

This event is triggered when a workspace custom code is interacted with.

Here’s an example payload:

​
Workspace file downloaded

This event is triggered when a workspace file is downloaded.

Here’s an example payload:

​
Workspace file viewed

This event is triggered when a workspace file is viewed.

Here’s an example payload:

​
Workspace message created

This event is triggered when a workspace message is created.

Here’s an example payload:

​
Workspace message commented

This event is triggered when a workspace message is commented on.

Here’s an example payload:

​
Workspace security profile document downloaded

This event is triggered when a workspace security profile document is downloaded.

Here’s an example payload:

​
Workspace security profile document viewed

This event is triggered when a workspace security profile document is viewed.

Here’s an example payload:

This event is triggered when a workspace security profile document link is clicked.

Here’s an example payload:

​
Workspace order form signed

This event is triggered when a workspace order form is signed.

Here’s an example payload:

​
Workspace order form fully signed

This event is triggered when a workspace order form is fully signed.

Here’s an example payload:

​
Workspace order form viewed

This event is triggered when a workspace order form is viewed.

Here’s an example payload:

​
Workspace order form downloaded

This event is triggered when a workspace order form is downloaded.

Here’s an example payload:

​
Workspace NDA signed

This event is triggered when a workspace NDA is signed.

Here’s an example payload:

​
Workspace text link clicked

This event is triggered when a workspace text link is clicked.

Here’s an example payload:

​
Workspace page viewed

This event is triggered when a workspace page is viewed.

Here’s an example payload:

​
Workspace section navigation clicked

This event is triggered when a workspace section navigation is clicked.

Here’s an example payload:

​
Workspace file widget file uploaded

This event is triggered when a file is uploaded from a file widget.

Here’s an example payload:

Verify webhook requests