Webhooks

Programmatically modify Webhook endpoints on your Teamwork.com Projects account.

These calls need to be made by an authenticated user who is an Administrator in the Owner Company

Get a list of all Webhook Events that can be used

Request

  • GET /webhooks/events.json

Response

{
  "STATUS": "OK",
  "events": [
    {
      "name": "COMMENT.CREATED",
      "id": "35"
    },
    {
      "name": "COMMENT.DELETED",
      "id": "37"
    },
    :
    :
  ]
}

Get all webhooks set on your account

Request

  • GET /webhooks.json

Response

{
  "webhooks": [
    {
      "event": "TASK.CREATED",
      "id": "34",
      "status": "ACTIVE",
      "url": "http://myserver.com/tw-webhooks/receiver.php",
      "validated": "1"
    },
    {
      "event": "TASK.UPDATED",
      "id": "32",
      "status": "ACTIVE",
      "url": "http://myserver.com/tw-webhooks/receiver.php",
      "validated": "1"
    },
    :
    :
  ],
  "STATUS": "OK"
}

Get details of a specific webhook set on your account

Request

  • GET /webhooks/:id.json

Response

{
  "webhook": {
      "event": "TASK.CREATED",
      "id": "34",
      "status": "ACTIVE",
      "url": "http://myserver.com/tw-webhooks/receiver.php",
      "validated": "1"
    },
  "STATUS": "OK"
}

Update a specific webhook set on your account

Request

  • PUT /webhooks/:id.json

{
  "webhook": {
      "event": "TASK.CREATED",      
      "status": "ACTIVE",
      "url": "http://myserver.com/tw-webhooks/receiver.php"      
    },
  "STATUS": "OK"
}

Response

{
  "STATUS": "OK"
}

Resume a specific webhook set on your account

Request

  • PUT /webhooks/:id/resume.json

Response

{
  "STATUS": "OK"
}

Pause a specific webhook on your account

Request

  • PUT /webhooks/:id/pause.json

Response

{
  "STATUS": "OK"
}

Delete a specific webhook on your account

Request

  • DELETE /webhooks/:id.json

Response

{
  "STATUS": "OK"
}

Create a new webhook on your account

Request

  • POST /webhooks.json

{
  "webhook": {
      "event": "TASK.CREATED",      
      "status": "ACTIVE",
      "url": "http://myserver.com/tw-webhooks/receiver.php"      
    },
  "STATUS": "OK"
}

Response

{
  "STATUS": "OK"
}

Enable Webhooks on your Teamwork.com Projects account

Request

  • PUT /webhooks/enable.json

Response

{
  "STATUS": "OK"
}

Disable Webhooks on your Teamwork.com Projects account

Request

  • PUT /webhooks/disable.json

Response

{
  "STATUS": "OK"
}