Check out Getting started with Webhooks before diving into this guide.
| Event | Type | Description |
|---|---|---|
| Task List Triggered | todo.assign | All general tasks triggered upon a task list trigger. |
| Change of Task Status | todo.changedStatus | Any change in the status of a general task - completed/incomplete |
Task List Triggered Payload
{
"companyId": 1,
"changedBy": {
"id": "2471054914621538305",
"companyId": 1,
"firstName": "Luke",
"surname": "Skywalker",
"email": "[email protected]",
"displayName": "Luke Skywalker",
"site": "Hong Kong (Demo)",
"siteId": 3
},
"toDos": [
{
"id": 9677,
"owner": {
"id": "2471054969701138446",
"firstName": "Frederick",
"surname": "Bateson",
"email": "[email protected]",
"displayName": "Frederick Bateson"
},
"title": "Set a 'first friday' night out",
"requestedFor": {
"id": "2471054981302583315",
"firstName": "Austin",
"surname": "Legge",
"email": "[email protected]",
"displayName": "Austin Legge"
},
"due": "2021-04-11",
"linkInBob": null,
"set": "Onboarding",
"workflow": "Onboarding",
"ordinalInWorkflow": 9,
"description": "How was week one for your new starter(s)? To welcome them properly, invite them out for a drink on their 'First Friday'",
"status": "Open",
"completionDate": null
},
{
"id": 9680,
"owner": {
"id": "2471054914621538305",
"firstName": "Bob",
"surname": "Skywalker",
"email": "[email protected]",
"displayName": "Bob Skywalker"
},
"title": "Send intro email to the company",
"requestedFor": {
"id": "2471054981302583315",
"firstName": "Austin",
"surname": "Legge",
"email": "[email protected]",
"displayName": "Austin Legge"
},
"due": "2021-04-09",
"linkInBob": null,
"set": "Onboarding",
"workflow": "Onboarding",
"ordinalInWorkflow": 11,
"description": "Make new starters feel like they belong by sending a welcome email to the entire company. The little things can make all the difference",
"status": "Open",
"completionDate": null
}
],
"requestedFor": {
"id": "2471054981302583315",
"companyId": 1,
"firstName": "Austin",
"surname": "Legge",
"email": "[email protected]",
"displayName": "Austin Legge",
"site": "New York (Demo)",
"siteId": 2
},
"pivotDate": "2021-04-08",
"assignmentType": "manually",
"workflow": {
"id": 1,
"name": "Onboarding",
"message": "<div>This is an onboarding tasklist</div>",
"automaticTriggerEnabled": false,
"automaticTrigger": {},
"filter": [
{
"fieldPath": "/internal/lifecycleStatus",
"operator": "text_equals",
"values": [
"employed"
]
}
],
"owner": "2471054979121545234"
},
"type": "todo.assign",
"creationDate": "2021-04-08T10:47:02.087"
}
Change of Task Status Payload
{
"companyId": 4765676,
"changedBy": {
"id": "2471054914621538305",
"companyId": 1,
"firstName": "Bob",
"surname": "Skywalker",
"email": "[email protected]",
"displayName": "Bob Skywalker",
"site": "Hong Kong",
"siteId": 3
},
"newStatus": "Closed",
"toDosBeforeChange": [
{
"id": 81,
"owner": {
"id": "2471054914621538305",
"firstName": "Bob",
"surname": "Skywalker",
"email": "[email protected]",
"displayName": "Bob Skywalker"
},
"title": "Open company email for new employee",
"requestedFor": {
"id": "247105491462156754",
"firstName": "John",
"surname": "Man",
"email": "[email protected]",
"displayName": "John Man"
},
"due": "2020-12-23",
"linkInBob": null,
"set": "Onboarding",
"workflow": "Onboarding",
"ordinalInWorkflow": 6,
"description": "Don’t forget to open an official company email account for your employee. Without this, you won’t be able to invite them to bob",
"status": "Closed",
"completionDate": "2021-04-07T14:26:36.5125"
}
],
"type": "todo.changedStatus",
"modificationDate": "2021-04-07T14:26:36.547"
}