Account
Account represents any external relationships, typically another company. The most common use case for an Account is your customer or sales prospect. Integration with external systems like Salesforce and HubSpot allows for seamless synchronization of account data, enhancing the management of client relationships and related business processes. All the accounts are associated with a company that can be accessed via the API. An account can also be created, updated via the API.Account model
Account model
Deal
Deals are a way to track and manage your sales pipeline. If you have a CRM integration, you can sync your deals(HubSpot deals, Salesforce opportunities, etc.) with Dock.Deal model
Deal model
string | null
The name of the deal.
string | null
The Hubspot deal ID (when deal is from Hubspot).
string | null
The Salesforce opportunity ID (when deal is from Salesforce).
number | null
Monetary value of the deal.
string | null
Expected or actual closing date of the deal.
Example format:
“2021-01-01T00:00:00.000Z”string | null
Date when the deal was created in the source system.
Example format:
“2021-01-01T00:00:00.000Z”string | null
Current stage of the deal.
string | null
Type of the deal.
User
User represents an individual who interacts with the Dock platform. Each user can be associated with a company, create or manage workspaces, and perform various tasks within the system. Users have roles, permissions, and can participate in collaborations, making them key actors in the product’s ecosystem.User model
User model
Template
Template represents a pre-defined group of pages & sections. Templates can be turned into Workspaces. Templates are a powerful way to build scalable processes across the organization. As your team members start to create their own Workspaces, templates can help them save time configuring and ultimately help ensure that everyone is following a similar framework. Read more about templates.Template model
Template model
Workspace
Workspaces are a shared space between your organization and an external organization. Since they are built on a flexible editor, they can be used for a variety of cases. You can create a workspace with a template too. Workspaces can be managed with the Workspaces API. Read more about workspaces.Workspace model
Workspace model
string
The name of the workspace.
string
The URL of the workspace.
string | null
The ID of the template.
string | null
The start date of the workspace.
string | null
The target end date of the workspace.
string | null
The actual end date of the workspace.
number
The age of the project.
string
The progress of the task.
string
The last client view of the workspace.
number
The total views of the workspace.
number
The total actions of the workspace.
number
The total time spent of the workspace.
number
The number of clients per workspace.
object | null
The account associated with the workspace.
object[]
Workspace domains associated with the workspace.
object[]
Workspace users associated with the workspace.
object | null
The deal associated with the workspace.
Workspace user
Workspace users are users who are associated with a workspace.Workspace user model
Workspace user model
Workspace domain
Workspace domains are domains that are associated with a workspace.Workspace domain model
Workspace domain model
Workspace page
Workspaces can be composed of multiple pages to help you organize your content. Each tab at the top of a workspace is a page. Workspace pages can be ordered, hidden, and have custom names. This allows you to organize your workspace in a way that makes sense for your team. Read more about workspace pages.Workspace page model
Workspace page model
Workspace section
Workspace pages are made up of a collection of Workspace Sections. Sections contain text, PDFs, images, links, widgets, and embeds. Sections are the building blocks of a workspace. Read more about workspace sections.Workspace section model
Workspace section model
string | null
The name of the workspace section.
The navigation name of the workspace section.
Whether the workspace section is hidden.
number
default:"1"
The index of the workspace section.
boolean
default:"false"
Whether the workspace section is synced.
boolean
default:"false"
Whether the workspace section is collaborative.
Whether the workspace section is hidden from navigation.
Workspace plan
Workspace plan is a project plan that organizes a group of tasks. Dock enables you to collaborate hands-on with customers and prospects through mutual action plans. You can customize Checklists, Timelines and Kanbans to help ensure you’re moving that customer relationship forward. You can also using them internally within a Workspace, to make sure you’re aligned with your team on your to-do’s! Read more about workspace plans.Workspace plan model
Workspace plan model
Workspace plan task
Workspace plan tasks represent an action item. These checklists are composed of tasks and can be helpful in assigning out responsibilities or tracking a “to-do” list of sorts. They are highly customizable — you can assign ownership, update the status of that item, and add a due date that sends out notifications automatically. Tasks include assignees, due dates, start dates, action buttons, descriptions, and comments. Read more about workspace plan tasks.Workspace plan task model
Workspace plan task model
boolean
default:"false"
Whether the task is internal.
string
default:"No status"
The status of the task.
string | null
The date and time when the task was completed.
string | null
The URL of the action link.
string | null
The name of the action link.
string | null
The text of the action.
enum<string> | null
The type of the action.
boolean
default:"true"
Whether the action text is shown.
string | null
The start date of the task.
string | null
The title of the task.
string | null
The due date of the task.
number | null
The index of the task.
Custom field
Custom fields are a way to add custom data to your deals, accounts, and workspaces.Custom field model
Custom field model
Asset
Assets are typically a piece of content (PDFs, links, images, or videos). Assets are found in Dock’s content library and can be tagged. Read more about assets.Asset model
Asset model
enum<string>
required
The type of the resource.
string
The name of the asset.
string | null
The description of the asset.
number
default:"0"
The number of views of the asset.
The number of shares of the asset.
enum<string>
required
The type of the asset.
string
The URL of the asset.
boolean
Whether the asset is restricted to internal use.
object[]
The tags associated with the asset.
Asset share link
Asset share links are the shareable URLs for an asset, attributed to a user. Each link comes in a trackable variant (engagement is attributed to the user) and a non-trackable public variant. You can retrieve them with the Asset share links API.File
Files represent uploaded files and downloadable attachments in Dock. You can retrieve a file with the Files API.File model
File model
Tag
Tags are labels you can use to organize and filter your content assets. For example, you might have a tag called “Integrations.” Searching for a tag returns all content assets associated with it. You can create and manage tags with the Tags API. Read more about content management in Dock’s Help Center.Tag model
Tag model
string
The title of the tag.