Create Webhook

POST /api/v1.0/webhooks

Bearer

This endpoint register a new webhook endpoint.

application/json

Body Required

endpoint string Required

Webhook Endpoint URL
event array[string] Required

Webhook events

Values are projectCreated, projectRemoved, projectUpdated, taskCreated, taskRemoved, taskUpdated, portfolioCreated, portfolioRemoved, portfolioUpdated, taskgroupCreated, taskgroupRemoved, taskgroupUpdated, messageCreated, messageRemoved, messageUpdated, milestoneCreated, milestoneRemoved, milestoneUpdated, documentCreated, documentUpdated, documentRemoved, fileCreated, fileRemoved, fileUpdated, labelCreated, labelRemoved, labelUpdated, subtaskCreated, subtaskRemoved, subtaskUpdated, timeTrackingRecordCreated, timeTrackingRecordUpdated, or timeTrackingRecordRemoved.
app_id string Required

Application id

Responses

201 application/json

The resource created successfully
Hide response attributes Show response attributes object
- message string Required
  
  Operation message
- webhook object Required
401

The client request has not been completed because it lacks valid authentication credentials for the requested resource.
403

The client does not have access rights to the content.
405

The request method is known by the server but is not supported by the target resource.

POST /api/v1.0/webhooks

curl \
 --request POST https://openapi.niftypm.com/api/v1.0/webhooks \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"endpoint":"string","event":["projectCreated"],"app_id":"string"}'

Request examples

{
  "endpoint": "string",
  "event": [
    "projectCreated"
  ],
  "app_id": "string"
}

Response examples (201)

{
  "message": "string",
  "webhook": {}
}