Schemas

Download schema

ErrorResponse

message

string · required

Human-readable reason.

Example: Unauthorized

code

number · required

Numeric code; equals the HTTP status for framework errors.

Example: 401

AppResponse

id

string · required

Application ID

name

string · required

Name

logo

string · required

Logo

redirect_urls

string · required

Redirect URLs

description

string · required

Description

scopes

string · enum · required

Application scope

Enum values:

file

label

doc

milestone

message

subtask

project

task_group

created_by

string · required

Created by

created_at

string · date-time · required

Created date

updated_at

string · date-time · required

Last updated date

GenerateRefreshToken

grant_type

string · enum · required

grant_type

Enum values:

authorization_code

refresh_token

code

string

Authorization code from the authorize redirect. Required for grant_type=authorization_code.

Example: Pk6DnFY4q9Z1X7aOQATV5z4bxg1rjwH4

client_id

string

OAuth app client id. Send it here or as the username half of HTTP Basic auth.

Example: SU9F98qri

client_secret

string

OAuth app client secret. Send it here or as the password half of HTTP Basic auth.

refresh_token

string

Refresh token from a previous call to this endpoint. Required for grant_type=refresh_token.

redirect_uri

string

Must match the redirect_uri the code was obtained with. Required for grant_type=authorization_code.

Example: https://app.example.com/oauth/callback

TokenResponse

access_token

string · required

Access Token

token_type

string · required

Token Type

refresh_token

string · required

Refresh token

expires_in

number · required

Expires in seconds

scope

string · enum · required

Scope

Enum values:

file

label

doc

milestone

message

subtask

project

task_group

ChatMemberResponse

id

string · required

is_owner

boolean · required

is_muted

boolean · required

joined

boolean · required

ChatResponse

id

string · required

name

string · required

type

string · required

description

string · required

team

string · required

project

string · required

is_self

boolean · required

ChatMemberResponse · required

created_at

string · date-time · required

last_message_at

string · date-time · required

zoom_id

string · required

zoom_password

string · required

zoom_join_url

string · required

webex_id

string · required

webex_password

string · required

webex_join_url

string · required

pinned_message

string · required

pinned_by

string · required

meeting_type

string · required

CreateDocument

name

string

Name

parent_doc_id

string

Parent Document ID

project_id

string

Project ID

googleAccessToken

string

Google Access Token

type

string

Type of Document

subtype

string

Subtype of the document

private

boolean

Private Flag

access_type

number · enum

Enum values:

content

object

Document Content. Native documents are always editor-v2, so this must be a plain string, or an array of editor-v2 nodes (each node either { text } or { type, children: [...] }); any other shape is rejected with a 400. Not supported on personal documents — a personal document is created empty and its body added in the app.

editor_version

number · enum

Editor version. Native Nifty documents are always created as 2 (the modern collaborative editor) — omit this field, or pass 2. The legacy editor (1) can no longer be used to create documents and passing it returns a 400; documents that already use it are unaffected and stay editable in the Nifty app. Note: the body of an editor-v2 document is collaborative — after creation it is edited in the app (or via agent tooling), not by updating content through this API.

Enum values:

external_id

string

External ID

folder_id

string

Folder ID

folder_stack

string[]

Folder stack

order

number

Document Order

CreateDocumentResponse

message

string · required

Operation message

doc_id

string · required

Document ID

folder

string · required

folde

DocumentMemberResponse

id

string · required

permission

string · required

is_author

boolean · required

active

boolean · required

last_seen

string · date-time · required

last_edited

string · date-time · required

DocumentResponse

id

string · required

name

string · required

access_type

string · required

type

string · required

subtype

string · required

external_id

string · required

content

object · required

author

string · required

project_id

string · required

tasks

string[] · required

archived

boolean · required

DocumentMemberResponse[] · required

discussion_keys

string[] · required

public_token

string · required

share_token

string · required

created_at

string · date-time · required

comments

number · required

hasAccess

boolean · required

labels

string[] · required

folder

string · required

order

number · required

multipage

boolean · required

parent_doc_id

string · required

GetDocumentsResponse

DocumentResponse[] · required

hasMore

boolean · required

True if there are more record else false

Default: false

CreatePersonalDocumentResponse

message

string · required

Message

doc_id

string · required

Document ID

EditDocument

name

string

Document name

archived

boolean

Archived

access_type

number · enum

Enum values:

force

boolean

Force Flag

content

object

folder_id

string

Folder ID

folder_stack

string[]

Folder path stack

multipage

boolean

Is Multiple page?

order

number

Document Order

MoveDocument

folder_id

string · required

Folder ID

folder_stack

string · required

Folder stack of document path

project_id

string · required

Project ID associated with the document

RemoveDocumentResponse

message

string · required

DocumentInvitee

id

string · required

permission

number · enum · required

Permission

Enum values:

DocumentInvite

DocumentInvitee[] · required

Document Invitee details

folder_stack

string[]

Folder stack

AddMembersToDocumentResponse

message

string · required

added_members

string[] · required

updated_members

string[] · required

DocumentMemberRemove

members

string[] · required

Document members

RemoveMembersFromDocumentResponse

message

string · required

members_id

string[] · required

ChangeDocument

object[] · required

Document content operations to apply, in order

changes_id

string

Client-generated id used to correlate the change echo over the socket

ProcessDocumentChangeResponse

success

boolean · required

UpdateLabels

labels

string[] · required

Labels

AddLabelsReponse

message

string · required

Message

labels

string[] · required

List of labels

RemoveLabelsResponse

message

string · required

Message

labels

string[] · required

List of labels

CustomFieldOptionResponse

id

string · required

value

string · required

Value

color

string · required

Color

CustomFieldResponse

id

string · required

name

string · required

Name

description

string · required

Description

type

string · required

Type

currency

string · required

Currency

tracking_type

string · required

Tracking Type

cost_per_hour

number · required

Cost Per Hour

associations

string[] · required

List of associations

hidden

string[] · required

List of hidden

CustomFieldOptionResponse[] · required

projects

string[] · required

List of Projects

in_library

boolean · required

FileFullResponse

id

string · required

name

string · required

size

number · required

url

string · required

download

string · required

thumbnail

string · required

uploader

string · required

comments

number · required

Number of comments

created_at

string · date-time · required

googleId

string · required

googleType

string · required

processed

boolean · required

task

string · required

Task

project_id

string · required

Project ID

message

string · required

Message

labels

string[] · required

List of labels

folder

string · required

folder

folder_stack

string[] · required

Folder path stack

document

string · required

Document

annotations_task_id

string · required

Annotation Task ID

GetFilesResponseDto

FileFullResponse[] · required

List of Label records

hasMore

boolean

True if there are more record else false

Default: false

FilesUploadDto

files

string[] · application/octet-stream

It contains list of files path from local desktop to upload.

UploadFilesResponseDto

FileFullResponse[] · required

List of Label records

message

string

Success message

GeneralFileResponse

message

string · required

Success message

id

string · required

Created Label ID

CopyFile

task_id

string · required

Task ID associated with the file

message_id

string · required

Message ID associated with the file

project_id

string · required

Project ID associated with the file

UpdateFile

folder_id

string

Folder ID

folder_stack

string[]

Folder stack

annotations_task_id

string

Annotations Task ID

UpdateFileResponse

message

string · required

Message

file_id

string · required

File ID

InviteeUser

id

string · required

User ID

name

string · required

Name

email

string · required

Email address

signedUp

string · required

Signedup Flag

signupDate

string · date-time · required

Signedup date

InviteeRole

id

string · required

Role ID

name

string · required

Role Name

InviteTeamMember

id

string · required

Team Member Id

object · required

User details

object · required

Role details

InviteTeamReponse

id

string · required

Team ID

name

string · required

Team name

url

string · required

Team URL

InviteTeamMember[] · required

Team member

LabelResponse

id

string · required

name

string · required

color

string · required

type

string · required

created_by

string · required

team

string · required

default

string · required

GetLabelsDto

LabelResponse[] · required

List of Label records

hasMore

boolean

True if there are more record else false

Default: false

LabelBody

name

string · required

Name

color

string · required

Color

type

number · enum

Type

Enum values:

GeneralLabelResponse

message

string · required

Success message

id

string · required

Label Record Unique ID

UpdateLabelBody

name

string · required

Name

color

string · required

Color

MemberViewResponse

id

string · required

email

string · required

Email address

name

string · required

Name

initials

string · required

Initials

avatar

string · required

Avtar

pending

boolean · required

Pending status

removed

boolean · required

Removed

theme

string · required

Theme

team

string · required

Team Id

role

string · required

Role

total_story_points

number · required

Total story point

completed_story_points

number · required

Completed story point

tz

number · required

Timezone

tz_iana

string · required

Timezone Code

tz_offset

string · required

Timezone Offset

color

string · required

Color

secondary_color

string · required

Secondary Color

online

boolean · required

Online status

signedUp

boolean · required

Signedup

tours

array[] · required

Tours

skipped_help

array[] · required

Skipped Help

notificationSettings

array[] · required

Notification Settings

user_id

string · required

User ID

labels

array[] · required

Labels

sidebar_tabs

boolean · required

Sidebar tabs

GetMembersReponse

MemberViewResponse[] · required

List of members

hasMore

boolean · required

True if there are more records else false

TaskReference

id

string · required

Id of an existing task.

Example: Kx8vQ2mT1

CreateMessageDto

type

string · required

Message Type

text

string · required

Message Text

url

string · required

URL

doc_attachment

string · required

Document Attachment

entity_key

string · required

Entity Key

chat_id

string · required

Chat ID

message_id

string · required

Message ID

task_id

string · required

Task ID

file_id

string · required

File ID

doc_id

string · required

Document ID

object

Task the message is attached to, referenced by id. Alternative to task_id.

external_files

string[]

List of External files

nifty_files

string[]

List of Nifty Files

date

string · date-time

Date

bot_name

string

BOT Name

bot_avatar

string

BOT Avtar

hidden

string[]

Hidden

emails

string

Emails

annotation_id

string

Annotation ID

context_text

string

Context Text

audio_duration

string

Audion Duration

CreateMessageResponse

message

string · required

data

object · required

FileChildResponse

id

string · required

name

string · required

size

number · required

url

string · required

download

string · required

thumbnail

string · required

uploader

string · required

comments

number · required

created_at

string · date-time · required

googleId

string · required

googleType

string · required

processed

boolean · required

MessageResponse

id

string · required

Message Id

type

string · required

Message Type

hide_link_preview

boolean · required

Hide Link Preview

subtype

string · required

Sub Type

text

string · required

Message text

url

string · required

URL

chat

string · required

Chat Id

thread

string · required

Thread

task

string · required

Task Id

file

string · required

File

document

string · required

Document Id

entity_key

string · required

Entity Key

author

string · required

Author Id

replies

number · required

No of Replies

repliers

string[] · required

List of Replier Id

tagged

string[] · required

List of tagged

seen_by

string[] · required

List of Seen by Id

hidden

string[] · required

Hidden

doc_attachment

string · required

Document Attachment

FileChildResponse[] · required

is_edited

boolean · required

Is Edited

is_deleted

boolean · required

Is Deleted

created_at

string · date-time · required

Created At

updated_at

string · date-time · required

Updated At

annotation_id

string · required

Annottion Id

heardBy

string[] · required

Heard By

audio_duration

number · required

Audio duration

heard

boolean · required

Is Heard

GetMessagesResponse

MessageResponse[] · required

List of messages

has_more

boolean · required

Has more row flag

EditMessageDto

text

string

Message Text

object[]

List of External Files

hide_link_preview

boolean

Hide link preview

nifty_files

string[]

List of Nifty Files

DeleteMessageResponse

message_id

string · required

Message ID

message

string · required

Message

SeeMessageResponse

message_ids

string[] · required

List of all message id

message

string · required

Message

HearMessageResponse

message_id

string · required

Message ID

message

string · required

Message

AttachedCustomFieldResponse

id

string · required

value

string · required

Value

TasksStatistic

total

number · required

Total

completed

number · required

Completed

overdue

number · required

Overdue

total_story_points

number · required

Total Story Point

completed_story_points

number · required

Completed Story Point

MilestoneShortView

id

string · required

Milestone ID

name

string · required

Milestone Name

created_at

string · date-time · required

Creation Date

created_by

string · required

Operation message

description

string · required

Description

dependency

string · required

Dependencies

start

string · date-time · required

Start Date

end

string · date-time · required

End Date

archived

string · required

achived

project

string · required

Project

task_group

string · required

Task Group

rule

string · required

Rules

tasks

string[] · required

List of Tasks

hidden

string[] · required

hidden

AttachedCustomFieldResponse[] · required

TasksStatistic · required

order

number · required

Order

color

string · required

Color

is_list

boolean · required

List Flag

assignees

string[] · required

Assignee to List

GetMilestonesReponse

hasMore

boolean · required

True if there are more record else false

Default: false

MilestoneShortView[] · required

List of Label records

CreateMilestone

project_id

string · required

Project ID

name

string · required

Milestone name

description

string · required

Milestone Description

task_group_id

string

Task Group ID

dependency

string

Milestone dependency

start

string

Milestone start date

end

string

Milestone end date

rule_id

string

Milestone rule id

hidden

string[]

Hidden

isTaskGroup

boolean

Is Task Group?

is_list

boolean

List Flag

MilestoneReponse

message

string · required

Success message

id

string · required

Created Label ID

UpdateMilestoneDto

name

string

Milestone name

description

string

Milestone description

dependency

string

Milestone dependencies

start

string

Milestone start date

end

string

Milestone end date

rollup

string

Milestone rollup

is_list

boolean

List Flag

UpdateMilestoneResponse

message

string · required

Success message

MoveToProjectMilestoneDto

project_id

string · required

Project ID

UpdateTasks

tasks

string[] · required

List of Tasks ID

MilestoneTasksResponse

message

string · required

Success message

tasks

string[] · required

List of tasks

UpdateStatus

archived

boolean · required

Archived

tasks

boolean

Task Flag

ProjectResponse

id

string · required

nice_id

string · required

name

string · required

description

string · required

initials

string · required

logo

string · required

color

string · required

secondary_color

string · required

demo

boolean · required

archived

boolean · required

auto_milestones

boolean · required

default_tasks_view

string · required

access_type

string · required

owner

string · required

members

string[] · required

general_discussion

string · required

subteam

string · required

progress

number · required

joined

boolean · required

general_discussion_muted

boolean · required

email

string · required

zoom_id

string · required

zoom_password

string · required

zoom_join_url

string · required

webex_id

string · required

webex_password

string · required

webex_join_url

string · required

enabled_modules

string[] · required

disabled_modules

string[] · required

disabled_widgets

number · enum · required

Enum values:

hidden_taskboard_fields

number · enum · required

Enum values:

repo

string · required

total_story_points

number · required

completed_story_points

number · required

pinned_message

string · required

pinned_by

string · required

completion_groups

string[] · required

doc_root_folder

object · required

file_root_folder

object · required

removed

boolean · required

rollups

string[] · required

list_columns_order

string[] · required

hidden_list_columns

string[] · required

integrations

string[] · required

Integration details

ProjectListResponse

ProjectResponse[] · required

List of Projects

hasMore

boolean · required

True if there are more record else false

Default: false

CreateProjectDto

name

string · required

Name

subteam_id

string

Subteam ID

description

string

Description

demo

boolean

Demo

template_id

string

Template ID

nice_id

string

Nice ID

access_type

string

Access Type

project_type

string

Project Type

default_tasks_view

string

Default Task View

disabled

string[]

Disabled

UpdateProjectDto

name

string

Name

description

string

Description

archived

string

Archived

auto_milestones

string

Auto milestone

subteam_id

string

Subteam ID

access_type

string

Access Type

default_tasks_view

string

Default Task View

disabled_widgets

string

Disable Widgets

hidden_taskboard_fields

string

Hidden Taskboard Fields

milestones_rollup

string

Milestone Rollup

color

string

Color

secondary_color

string

Secondary Color

nice_id

string

Nice ID

hidden_list_columns

string

Hidden List Columns

list_columns_order

string

Columns Order List

query_all_files

string

Query All Fields

GeneralProjectReponse

message

string · required

Success message

id

string · required

Created ID

DeleteProjectReponse

message

string · required

Success message

InviteProjectMember

email

string · required

role

string · required

Role type any of the owner, manager, regular, client

name

string

Name

InviteProjectDto

InviteProjectMember[] · required

Invitees

ProjectInviteResponse

message

string · required

Operation message

object[] · required

Invited

LeaveProjectReponse

message

string · required

Success message

member_id

string · required

Member ID

CustomFieldOptions

value

string · required

Custom field option value

color

string · required

Custom field option color

CreateCustomField

name

string · required

Custom field name

type

number · enum · required

Custom field type

Enum values:

CustomFieldOptions[] · required

roles

string[] · required

Roles

field_id

string

field_id

description

string

description

currency

string

Currency

tracking_type

number · enum

Tracking Type

Enum values:

cost_per_hour

number

Cost per hour

save

boolean

Save

association

string

Association

project_id

string

Project ID

CreateSubteam

name

string · required

Name

SubteamGeneralResponse

message

string · required

id

string · required

SubteamResponse

id

string · required

name

string · required

initials

string · required

logo

string · required

color

string · required

secondary_color

string · required

is_general

boolean · required

owner

string · required

members

string[] · required

GetSubTeamsResponse

SubteamResponse[] · required

items

boolean · required

True if there are more record else false

Default: false

hasMore

boolean · required

True if there are more record else false

Default: false

UpdateSubteam

name

string

Name

order

string

Sort position, sent as a numeric string

Example: 300

SubteamMembersModify

members_ids

string[] · required

List of Members ID

RelatedPR

number

string · required

title

string · required

url

string · required

status

string · required

TaskResponse

id

string · required

nice_id

string · required

Nice ID

name

string · required

Name

description

string · required

Description

order

number · required

Order

created_at

string · date-time · required

Created Date

created_by

string · required

Created By

archived

boolean · required

Archived Flag

completed

boolean · required

Completed Flag

completed_on

string · date-time · required

Completed Date

completed_by

string · required

Completed By

due_date

string · date-time · required

Due Date

reminder

string · date-time · required

Reminder Date

task_group

string · required

Task Group

task

string · required

Task

project

string · required

Project ID

milestone

string · required

Milestone

assignees

string[] · required

Assignees

linked_tasks

string[] · required

Linked Tasks

subscribers

string[] · required

Subscribers

labels

string[] · required

Labels

AttachedCustomFieldResponse[] · required

Attached custom fields

total_subtasks

number · required

Total Number of subtasks

completed_subtasks

number · required

Number of completed tasks

comments

number · required

Numbers of comments

FileChildResponse[] · required

Files

documents

string[] · required

List of Documents

banner

string · required

Banner

hidden

string[] · required

hidden

dependency

string · required

Dependencies

repeat_cron

string · required

Repeat Cron

repeat_trigger

string · required

Repeat Trigger

embed_url

string · required

Embedded URL

repeat_till

string · date-time · required

Repeat Until

rule

string · required

Rule ID

story_points

number · required

Story Points

related_commits

string[] · required

RelatedPR · required

archived_on

string · date-time · required

Archived Date

tracked_time

number · required

Tracked Time

start_date

string · date-time · required

Start Date

project_archived

boolean · required

Project Archived

meeting_ids

string[] · required

Meeting IDs

GetTasksResponse

TaskResponse[] · required

List of all tasks

hasMore

boolean · required

True when the page was full (tasks.length === limit); a full final page also reports true — request the next page to confirm.

Default: false

CreateTaskFieldBody

id

string · required

value

string · required

Value

CreateTaskBody

name

string · required

Name

task_group_id

string · required

Task Group ID

description

string

Description

order

number

Order

task_id

string

Task Id. This field is mandatory only when we want to create this task as subtask of other task.

milestone_id

string

Milestone ID

rule_id

string

Rule ID

annotation_id

string

Annotation ID

due_date

string

Due Date

start_date

string

Start Date

assignees

string[]

List of Assignees

labels

string[]

List of labels

meeting_ids

string[]

List of meeting ID

embed_url

string

Embed URL

banner

string

Banner

CreateTaskFieldBody[]

Task Field Body

story_points

number

Story Points

object

Task this one is blocked by, referenced by id.

GetPersonalTasksDto

limit

string

Page size. Defaults to 25; the maximum is 1000 — larger values are reduced to 1000, and 0 means 100. Page on with offset; a page shorter than limit is the last one.

Example: 25

Default: 25

offset

string

Record Offset

Example: 0

meeting_id

string

Meeting ID

completed

boolean

Completed?

IdReference

id

string · required

Id of the referenced record.

Example: i5vtiganU9y25V

PersonalTaskResponse

id

string · required

Task id.

Example: PtQ7bK2wR

niceId

number · required

Per-creator sequence number for personal tasks; the highest existing value plus one.

Example: 12

name

string · required

Task name.

Example: Draft Q4 board deck

description

string · required

Task description; Nifty Markdown.

Example: Pull the revenue chart from the finance sheet first.

order

number · required

Rank among the creator's personal tasks. Assigned as the midpoint between neighbours, or 100 for the first task.

Example: 100

personal

boolean · required

Always true on this endpoint — personal tasks belong to no project.

Example: true

startDate

string · date-time · required

Start date, or null when none was sent (ISO 8601, UTC).

Example: 2026-09-07T09:00:00.000Z

dueDate

string · date-time · required

Due date, or null when none was sent (ISO 8601, UTC).

Example: 2026-09-11T17:00:00.000Z

createdAt

string · date-time · required

Creation timestamp (ISO 8601, UTC).

Example: 2026-09-04T11:48:02.317Z

updatedAt

string · date-time · required

Last modification timestamp (ISO 8601, UTC).

Example: 2026-09-04T11:48:02.317Z

object · required

The team member who created the task.

object · required

Parent task when the request carried task_id, making this a subtask; null otherwise.

object · required

Recurring rule that produced the task when the request carried rule_id; null otherwise.

assignees

string[] · required

Always empty on the create response — assignees are cleared before the task is returned.

Example: []

hiddenFor

string[] · required

Roles the task is hidden from. Always empty for a personal task.

Example: []

meeting_ids

string[] · required

Meeting ids sent on the request, when any.

Example: []

UpdateTaskResponse

message

string · required

Success message

RemoveTaskResponse

message

string · required

Success message

UpdateTaskMilestoneReponse

message

string · required

Success message

CompletedTaskResponse

message

string · required

Success message

MoveTarget

type

string · required

Type

id

string · required

MoveTaskNew

object · required

task_order

string

Task Order

next_task

string

Next Task

prev_task

string

Previous Task

AssigneesBody

assignees

string[] · required

List of Assignees

AddLabelsToTaskResponse

message

string · required

labels

string[] · required

RemoveTasks

project_id

string

Project ID

task_ids

string[]

List of Task ID

MoveTasks

object · required

task_ids

string[] · required

List of Task ID

TaskGroupResponse

id

string · required

name

string · required

order

number · required

project_id

string · required

color

string · required

milestone

string · required

is_completion_group

boolean · required

assignees

string[] · required

hidden

string[] · required

rollup

object · required

GetTaskGroupsResponse

TaskGroupResponse[] · required

hasMore

boolean

True if there are more record else false

Default: false

CreateTaskGroupBody

name

string · required

Name

project_id

string · required

Project ID

order

number

Order

color

string

Color

isCompletionGroup

boolean

Is Completion Group

TaskGroupCompactResponse

id

string · required

name

string · required

created_by

string · required

project

string · required

color

string · required

order

number · required

assignees

string[] · required

rollup

string · required

UpdateTaskGroupDto

name

string

order

number

color

string

is_completion_group

boolean

Is Completion Group

archived

boolean

Archived

rollup

string

Rollup

TaskGroupGeneralResponse

message

string · required

Success message

MoveAllTasks

target

string · required

Target

InviteMember

email

string · required

role

string · required

Role

name

string

Name

InviteDto

InviteMember[] · required

List of members

TemplateResponseDto

ID

string · required

Name

string · required

Description

string · required

Template Type

string · required

Public Token

string · required

Created Date

string · date-time · required

Updated Date

string · date-time · required

Created by Team member Id

string · required

GetWebhooksDto

limit

number · required

No of records per page

Example: 25

offset

number · required

Record Offset

Example: 0

WebhookResponse

id

string · required

Webhook id.

Example: W1qZ8mKrT

endpoint

string · required

HTTPS endpoint Nifty POSTs each event to.

Example: https://hooks.example.com/nifty

registered_event

string[] · required

Events this endpoint is subscribed to.

Enum values:

projectCreated

projectRemoved

projectUpdated

taskCreated

taskRemoved

taskUpdated

portfolioCreated

portfolioRemoved

Example: ["taskCreated","taskUpdated"]

createdAt

string · date-time · required

When the webhook was registered (ISO 8601, UTC).

Example: 2026-08-14T09:21:07.412Z

updatedAt

string · date-time · required

When the webhook was last modified (ISO 8601, UTC).

Example: 2026-08-21T16:02:55.108Z

GetWebhooksResponse

WebhookResponse[] · required

Registered webhooks

hasMore

boolean · required

True if there are more record else false

Default: false

CreateWebhookDto

endpoint

string · required

Webhook Endpoint URL

event

string[] · required

Webhook events

Enum values:

projectCreated

projectRemoved

projectUpdated

taskCreated

taskRemoved

taskUpdated

portfolioCreated

portfolioRemoved

app_id

string · required

Application id

CreateWebhookReponse

message

string · required

Operation message

object · required

The registered webhook

RemoveWebhookDto

app_id

string · required

Application ID

RemoveWebhookResponse

message

string · required

Operation message

webhook_id

string · required

Webhook ID

UpdateWebhookDto

endpoint

string · required

Webhook Endpoint URL

event

string[] · required

Webhook Event

Enum values:

projectCreated

projectRemoved

projectUpdated

taskCreated

taskRemoved

taskUpdated

portfolioCreated

portfolioRemoved

app_id

string · required

Application ID

UpdateWebhookResponse

message

string · required

Operation message

webhook_id

string · required

Updated webhook record id

Was this page helpful?