Nifty API
  • Authentication
  • OAuth 2.1
  • v1.0 API
  • API tokens
Information
Apps
    Get AppsgetGet Appget
Authentication
    Generate TokenpostAuthorize (browser entry point)get
Chats
    Get ChatsgetGet Chatget
Documents
    Get DocumentsgetCreate documentpostGet Personal DocumentsgetCreate Personal DocumentpostGet DocumentgetUpdate DocumentputRemove DocumentdeleteMove DocumentputUpdate Document MemberputRemove Document MemberdeleteUpdate DocumentpostUpdate Document LabelsputRemove Document Labelsdelete
Custom Fields
    Get Custom fieldsgetGet Custom fieldget
Files
    Get FilesgetUpload FilespostGet FilegetUpdate FileputRemove FiledeleteCopy FilepostAdd File LabelsputRemove File Labelsdelete
Folders
    Get Folder ChildrengetAdd FolderpostGet Folderget/api/v2.0/folders/{folderId}putRemove FolderdeleteGet Folder Conntentsget
Invite
    Get Inviteeget
Tags
    Get TagsgetCreate TagpostGet TaggetUpdate TagputRemove Tagdelete
Members
    Get Members DetailsgetGet Member Detailsget
Messages
    Get MessagesgetCreate MessagepostGet MessagegetUpdate MessageputRemove MessagedeleteMark Message seenpostMark Message heardpost
Milestones & Lists
    Get MilestonesgetCreate MilestonepostGet MilestonegetUpdate MilestoneputRemove MilestonedeleteMove MilestoneputTie Task To MilestoneputRemove Milestone TaskdeleteArchive Milestonepost
Projects
    Get ProjectsgetCreate ProjectpostGet ProjectgetUpdate ProjectputRemove ProjectdeleteInvite Team Member for projectpostLeave ProjectpostStart ProjectpostGet Project Custom FieldsgetAdd Project Custom FieldspostUpdate Project Custom Fieldsput
Portfolios
    Get PortfoliosgetCreate PortfoliopostGet PortfoliogetUpdate PortfolioputRemove PortfoliodeleteUpdate Portfolio MemberputRemove Portfolio MemberdeleteLeave Portfoliopost
Tasks
    Get TasksgetCreate TaskpostRemove TaskdeleteGet Personal TasksgetCreate Personal TaskpostGet TaskgetUpdate TaskputRemove TaskdeleteUpdate Task MilestoneputComplete TaskpostArchive TaskpostMove TaskpostAssign TaskputRemove AssigneedeleteAdd LabelsputRemove LabelsdeleteGet FieldsgetAdd FieldspostUpdate FieldsputAdd DocumentputClone TaskpostMove Taskpost
Status
    Get StatusesgetCreate StatuspostGet StatusgetUpdate StatusputRemove StatusdeleteMove TaskspostAssign Status MembersputRemove Status Memberdelete
Templates
    Get Templatesget
Time Tracking
    Get Tracked Time ReportgetGet Tracked Time Durationget
Users
    Get User Detailsget
Webhook
    Get WebhooksgetCreate WebhookpostUpdate WebhookputRemove Webhookdelete
Other endpoints
    /get
Schemas
powered by Zudoku
Nifty API v1.0
Nifty API v1.0

Webhook


Get Webhooks

GET
https://openapi.niftypm.com
/api/v1.0/webhooks/{app_id}

This endpoint fetch list of all webhook registerd by team member.

Get Webhooks › path Parameters

app_id
​string · required

Enter application id

Get Webhooks › Request Body

GetWebhooksDto
limit
​number · required

No of records per page

Example: 25
offset
​number · required

Record Offset

Example: 0

Get Webhooks › Responses

Success Response

GetWebhooksResponse
webhooks
​string[] · required

Webhook

hasMore
​boolean · required

True if there are more record else false

Default: false
GET/api/v1.0/webhooks/{app_id}
curl https://openapi.niftypm.com/api/v1.0/webhooks/:app_id \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "limit": "25", "offset": "0" }'
Example Request Body
{ "limit": "25", "offset": "0" }
json
Example Responses
{ "webhooks": [ "string" ], "hasMore": false }
json
application/json

Create Webhook

POST
https://openapi.niftypm.com
/api/v1.0/webhooks

This endpoint register a new webhook endpoint.

Create Webhook › Request Body

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

Create Webhook › Responses

The resource created successfully

CreateWebhookReponse
message
​string · required

Operation message

webhook
​object · required

Webhook

POST/api/v1.0/webhooks
curl https://openapi.niftypm.com/api/v1.0/webhooks \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "endpoint": "endpoint", "event": [ "projectCreated" ], "app_id": "app_id" }'
Example Request Body
{ "endpoint": "endpoint", "event": [ "projectCreated" ], "app_id": "app_id" }
json
Example Responses
{ "message": "message", "webhook": {} }
json
application/json

Update Webhook

PUT
https://openapi.niftypm.com
/api/v1.0/webhooks/{webhook_id}

This endpoint updates an existing webhook endpoint.

Update Webhook › path Parameters

webhook_id
​string · required

Enter webhook id

Update Webhook › Request Body

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

Update Webhook › Responses

Success Response

UpdateWebhookResponse
message
​string · required

Operation message

webhook_id
​string · required

Updated webhook record id

PUT/api/v1.0/webhooks/{webhook_id}
curl https://openapi.niftypm.com/api/v1.0/webhooks/:webhook_id \ --request PUT \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "endpoint": "endpoint", "event": [ "projectCreated" ], "app_id": "app_id" }'
Example Request Body
{ "endpoint": "endpoint", "event": [ "projectCreated" ], "app_id": "app_id" }
json
Example Responses
{ "message": "message", "webhook_id": "webhook_id" }
json
application/json

Remove Webhook

DELETE
https://openapi.niftypm.com
/api/v1.0/webhooks/{webhook_id}

This endpoint remove webhook endpoint.

Remove Webhook › path Parameters

webhook_id
​string · required

Enter webhook id

Remove Webhook › Request Body

RemoveWebhookDto
app_id
​string · required

Application ID

Remove Webhook › Responses

The record has been updated successfully.

RemoveWebhookResponse
message
​string · required

Operation message

webhook_id
​string · required

Webhook ID

DELETE/api/v1.0/webhooks/{webhook_id}
curl https://openapi.niftypm.com/api/v1.0/webhooks/:webhook_id \ --request DELETE \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "app_id": "app_id" }'
Example Request Body
{ "app_id": "app_id" }
json
Example Responses
{ "message": "message", "webhook_id": "webhook_id" }
json
application/json

UsersOther endpoints