Sample Payloads

Project

{
  "eventCreator": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://www.teamwork.com/users/1/avatar.png"
  },
  "project": {
    "id": 1234,
    "name": "Test Project",
    "description": "This is testing project",
    "status": "active",
    "startDate": "2014-04-14",
    "endDate": "2017-08-09",
    "tags": [
      {
        "id": 339,
        "name": "jambo",
        "color": "4d4d4d"
      }
    ],
    "companyId": 1,
    "categoryId": 30716,
    "dateCreated": "2014-04-14T13:32:50Z"
  }
}

Milestone

{
  "eventCreator": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://www.teamwork.com/users/1/avatar.png"
  },
  "milestone": {
    "id": 481841,
    "name": "Publish v2 Webhook Docs",
    "description": "Gotta get em out there!",
    "deadline": "2017-08-09",
    "status": "new",
    "projectId": 1234,
    "tags": [],
    "dateCreated": "2017-08-09T08:01:00Z",
    "dateUpdated": "2017-08-09T08:01:00Z"
  }
}

Tasklist

{
  "eventCreator": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://www.teamwork.com/users/1/avatar.png"
  },
  "taskList": {
    "id": 4321,
    "name": "Important Tasks",
    "description": "Tasks that are very important",
    "status": "new",
    "milestoneId": 0,
    "projectId": 1234,
    "tags": []
  }
}

Task

{
  "eventCreator": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://www.teamwork.com/users/1/avatar.png"
  },
  "task": {
    "id": 5678,
    "name": "Do Something Important",
    "priority": "high",
    "status": "new",
    "parentId": 0,
    "taskListId": 4321,
    "startDate": "2017-08-09",
    "dueDate": "2017-08-16",
    "tags": [
      {
        "id": 4,
        "name": "emergency",
        "color": ""
      }
    ],
    "projectId": 1234,
    "dateCreated": "2017-08-09T08:11:00Z",
    "dateUpdated": "2017-08-09T08:11:16Z"
  },
  "taskList": {
    "id": 4321,
    "name": "Important Tasks",
    "description": "",
    "status": "new",
    "milestoneId": 0,
    "projectId": 1234,
    "tags": []
  }
}

Company

{
  "eventCreator": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://www.teamwork.com/users/1/avatar.png"
  },
  "company": {
    "id": 1,
    "name": "Test Company",
    "website": "http://www.teamwork.com",
    "phone": "",
    "fax": "",
    "addressLine1": "Teamwork Campus One",
    "addressLine2": "Blackpool",
    "city": "Cork",
    "state": "",
    "zip": "",
    "countryCode": "IE",
    "email": "support@teamwork.com",
    "secondaryEmail": "",
    "tertiaryEmail": "",
    "logo": ""
  }
}

Calender Event

{
  "eventCreator": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://www.teamwork.com/users/1/avatar.png"
  },
  "event": {
    "id": 7175,
    "title": "Holiday",
    "description": "Rainbows and sunshine.",
    "where": "Promiseland",
    "start": "2017-08-10T07:45:00Z",
    "end": "2017-08-10T08:45:00Z",
    "allDay": false,
    "type": {
      "id": 1111,
      "name": "Holiday",
      "color": "AD2C29"
    },
    "privacy": {
      "type": "company"
    },
    "reminders": [
      {
        "id": 8173,
        "type": "email",
        "before": 10,
        "period": "minutes"
      }
    ],
    "attendees": [
      {
        "id": 1,
        "firstName": "John",
        "lastName": "Doe",
        "avatar": "https://www.teamwork.com/users/1/avatar.png"
      }
    ],
    "dateCreated": "2017-08-09T07:44:58Z",
    "dateUpdated": "2017-08-09T07:44:58Z"
  }
}

File

{
  "eventCreator": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://www.teamwork.com/users/1/avatar.png"
  },
  "file": {
    "id": 1600078,
    "version": 2,
    "description": "",
    "status": "active",
    "categoryId": 0,
    "projectId": 1234,
    "tags": [
      {
        "id": 51739,
        "name": "cat",
        "color": "f78234"
      },
      {
        "id": 51737,
        "name": "cute",
        "color": "f47fbe"
      }
    ],
    "dateUpdated": "2017-08-09T07:52:12Z",
    "versionId": 1662706,
    "name": "cute cat",
    "nameOnDisk": "23195528a37034c562.jpg",
    "originalName": "23195528a37034c562.jpg",
    "size": 140930,
    "fileSource": "teamworkprojects",
    "thumbUrl": "https://tw-s3.teamworkpm.net/?action=getThumb&ref=19.157f3.255.18681b.2",
    "dateCreated": "2015-11-26T10:00:10Z"
  }
}

Notebook

{
  "eventCreator": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://www.teamwork.com/users/1/avatar.png"
  },
  "notebook": {
    "id": 187241,
    "name": "My Diary - Day 1",
    "description": "All my secrets and stuff",
    "tags": [],
    "categoryId": 583869,
    "projectId": 1234,
    "dateCreated": "2017-08-09T08:03:25Z",
    "version": 1,
    "versionId": 383223
  }
}

Link

{
  "eventCreator": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://www.teamwork.com/users/1/avatar.png"
  },
  "link": {
    "id": 98928,
    "title": "Teamwork Desk",
    "description": "Brand new website for Teamwork Desk, check it out!",
    "code": "https://www.teamworkdesk.com",
    "width": 800,
    "height": 600,
    "tags": [],
    "categoryId": 0,
    "projectId": 1234,
    "dateCreated": "2017-08-09T07:56:50Z",
    "dateUpdated": "2017-08-09T07:56:50Z"
  }
}

Time

{
  "eventCreator": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://www.teamwork.com/users/1/avatar.png"
  },
  "time": {
    "id": 123456789,
    "hours": 0,
    "minutes": 30,
    "date": "2017-08-09T07:43:00Z",
    "userId": 1,
    "description": "Done some important stuff.",
    "billable": true,
    "invoiceId": 0,
    "taskId": 5678,
    "projectId": 1234,
    "tags": [
      {
        "id": 1,
        "name": "important",
        "color": "2f8de4"
      }
    ],
    "dateCreated": "2017-08-09T08:14:30Z",
    "dateUpdated": "2017-08-09T08:14:30Z"
  }
}

Message

{
  "eventCreator": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://www.teamwork.com/users/1/avatar.png"
  },
  "message": {
    "id": 711775,
    "subject": "Hello everybody!",
    "status": "active",
    "categoryId": 122498,
    "projectId": 1234,
    "tags": [
      {
        "id": 4,
        "name": "emergency",
        "color": ""
      }
    ],
    "post": {
      "id": 2082986,
      "body": "<div class='fr-view'>How's life?</div>",
      "contentType": "HTML",
      "status": "active",
      "userId": 1,
      "messageId": 711775,
      "dateCreated": "2017-08-09T07:58:06Z",
      "dateUpdated": "2017-08-09T07:58:06Z"
    }
  }
}

Message Replies

{
  "eventCreator": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://www.teamwork.com/users/1/avatar.png"
  },
  "messagePost": {
    "id": 2082988,
    "body": "<div class='fr-view'>All good! How's yours?</div>",
    "contentType": "HTML",
    "status": "active",
    "userId": 1,
    "messageId": 711775,
    "dateCreated": "2017-08-09T07:59:25Z",
    "dateUpdated": "2017-08-09T07:59:25Z"
  }
}

Comment

{
  "eventCreator": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://www.teamwork.com/users/1/avatar.png"
  },
  "comment": {
    "id": 5458556,
    "contentType": "HTML",
    "body": "<div class='fr-view'>Test comment, please ignore.</div>",
    "userId": 1,
    "objectId": 13440722,
    "objectType": "task",
    "projectId": 1234,
    "dateCreated": "2017-08-09T07:48:02Z",
    "dateUpdated": "2017-08-09T07:48:02Z"
  }
}

Invoice

{
  "eventCreator": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://www.teamwork.com/users/1/avatar.png"
  },
  "invoice": {
    "id": 82230,
    "number": "INV-00420",
    "poNumber": "",
    "description": "",
    "date": "2017-08-09",
    "status": "active",
    "currencyCode": "USD",
    "fixedCost": null,
    "projectId": 1234,
    "companyId": 0,
    "dateCreated": "2017-08-09T07:55:31Z",
    "dateUpdated": "2017-08-09T07:55:31Z"
  }
}

Expense

{
  "eventCreator": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://www.teamwork.com/users/1/avatar.png"
  },
  "expense": {
    "id": 21186,
    "name": "Poptarts",
    "description": "Gotta stock up",
    "date": "2017-08-09",
    "cost": 500,
    "invoiceId": 0,
    "projectId": 1234,
    "dateUpdated": "2017-08-09T07:51:11Z"
  }
}

Risk

{
  "eventCreator": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://www.teamwork.com/users/1/avatar.png"
  },
  "risk": {
    "id": 17222,
    "source": "Alien Invasion",
    "probability": "LOW",
    "probabilityValue": 1,
    "impact": "HIGH",
    "impactValue": 9,
    "result": 9,
    "impactCost": true,
    "impactPerformance": true,
    "impactSchedule": true,
    "mitigationPlan": "Pay Elon Musk to get us to Mars.",
    "status": "new",
    "projectId": 1234,
    "dateCreated": "2017-08-09T08:05:48Z",
    "dateUpdated": "2017-08-09T08:05:48Z"
  }
}

Column

{
  "eventCreator": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://www.teamwork.com/users/1/avatar.png"
  },
  "column": {
    "id": 6543,
    "name": "Published",
    "color": "6866D0",
    "status": "active",
    "dateCreated": "2017-08-09T07:47:12Z",
    "dateUpdated": "2017-08-09T07:47:12Z"
  }
}

Card

{
  "eventCreator": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://www.teamwork.com/users/1/avatar.png"
  },
  "card": {
    "id": 3456,
    "columnId": 6543,
    "taskId": 5678,
    "projectId": 1234,
    "status": "ACTIVE",
    "archived": false,
    "dateArchived": null,
    "dateCreated": "2017-08-09T07:46:14Z",
    "dateUpdated": "2017-08-09T07:46:15Z",
    "name": "Hello",
    "priority": null,
    "taskStatus": "new",
    "parentId": 0,
    "taskListId": 1345083,
    "startDate": null,
    "dueDate": null,
    "tags": []
  },
  "column": {
    "id": 6543,
    "name": "Published",
    "color": "6866D0",
    "status": "active",
    "dateCreated": "2017-08-09T07:47:12Z",
    "dateUpdated": "2017-08-09T07:47:12Z"
  }
}

Status

{
  "eventCreator": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://www.teamwork.com/users/1/avatar.png"
  },
  "status": {
    "id": 9876,
    "userId": 1,
    "date": "2017-08-09T08:09:12Z",
    "message": {
      "id": 8765,
      "text": "DnD: Working on webhooks v2 documentation."
    }
  }
}

Role

{
  "eventCreator": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://www.teamwork.com/users/1/avatar.png"
  },
  "role": {
    "id": 59935,
    "name": "Graphic Designer",
    "description": "Responsible with designing our web and mobile apps",
    "projectId": 1234
  }
}

User

{
  "eventCreator": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://www.teamwork.com/users/1/avatar.png"
  },
  "user": {
    "id": 1,
    "email": "john.doe@yourcompany.com",
    "firstName": "John",
    "lastName": "Doe",
    "avatar": "https://www.teamwork.com/users/1/avatar.png",
    "type": "account",
    "companyId": 1,
    "dateCreated": "2014-03-26T17:25:39Z",
    "dateUpdated": "2017-08-09T08:15:23Z"
  }
}

Board

{
    "eventCreator": {
        "id": 1,
        "firstName": "John",
        "lastName": "Doe",
        "avatar": "https://www.teamwork.com/users/1/avatar.png"
    },
    "portfolioBoard": {
        "id": 1234,
        "name": "Test 1",
        "description": "",
        "color": "D35400",
        "dateCreated": "2017-08-10T07:45:00Z",
        "dateUpdated": "2017-08-10T07:45:00Z"
    },
}

Card/Column

{
    "eventCreator": {
        "id": 1,
        "firstName": "John",
        "lastName": "Doe",
        "avatar": "https://www.teamwork.com/users/1/avatar.png"
    },
    "portfolioBoard": {
        "id": 1234,
        "name": "Test 1",
        "description": "",
        "color": "D35400",
        "dateCreated": "2017-08-10T07:45:00Z",
        "dateUpdated": "2017-08-10T07:45:00Z"
    },
    "portfolioColumn": {
        "id": 5678,
        "name": "Test Column",
        "color": "F39C12",
        "status": "active",
        "dateCreated": "2017-08-10T07:45:00Z",
        "dateUpdated": "2017-08-10T07:45:00Z",
        "portfolioBoardId": 1
    }
}

Feedback

If you have any feedback or suggestions, feel free to contact us at api@teamwork.com.