Project Checklists


project_checklist_created

Payload data sent after Checklist Node creation.

Properties

Property Type Format Required Description
type string true Payload type (project_checklist_created)
actionUserId string UUID true User identifier
actionExternalUserId string false User external identifier
projectId string UUID true Project identifier
projectExternalId string false Project external identifier
data ChecklistNode true Created payload date

Example

{
  "type": "project_checklist_created",
  "projectId": "310c5fda-906d-4f44-bf4d-a51d5ef55b99",
  "projectExternalId": "1",
  "actionUserId": "110c5fda-226d-4f44-bf4d-a11d5ef55b33",
  "actionExternalUserId": "externalId",
  "data": {
    "id": "3f582b1f-0ea4-46aa-b6c2-03a68b8e7805",
    "parentId": "e5ac0f71-591f-4d1d-8373-f5a394e799ee",
    "name": "B1 - Eng",
    "sfi": "2.22.00030",
    "progress": "21",
    "externalId": "3",
    "status": null,
    "dueDate": null,
    "hoursPlanned": null,
    "hoursSpent": null,
    "notes": null,
    "description": null,
    "relevantURL": null,
    "plannedStartDate": null,
    "startedAt": null,
    "completedAt": null,
    "verifiedAt": null
  }
}

project_checklist_updated

Payload data sent after Checklist Node update.

Properties

Property Type Format Required Description
type string true Payload type (project_checklist_updated)
actionUserId string UUID true User identifier
actionExternalUserId string false User external identifier
projectId string UUID true Project identifier
projectExternalId string false Project external identifier
data ChecklistNode true Created payload date

Example

{
  "type": "project_checklist_updated",
  "projectId": "310c5fda-906d-4f44-bf4d-a51d5ef55b99",
  "projectExternalId": "1",
  "actionUserId": "110c5fda-226d-4f44-bf4d-a11d5ef55b33",
  "actionExternalUserId": "externalId",
  "data": {
    "id": "3f582b1f-0ea4-46aa-b6c2-03a68b8e7805",
    "parentId": "e5ac0f71-591f-4d1d-8373-f5a394e799ee",
    "name": "Some checklists update",
    "sfi": "2.22.00030",
    "progress": "50",
    "externalId": "1",
    "status": null,
    "dueDate": null,
    "hoursPlanned": null,
    "hoursSpent": null,
    "notes": null,
    "description": null,
    "relevantURL": null,
    "plannedStartDate": null,
    "startedAt": null,
    "completedAt": null,
    "verifiedAt": null
  }
}

project_checklist_archived

Payload data sent after Checklist Node is archived.

Properties

Property Type Format Required Description
type string true Payload type (project_checklist_archived)
actionUserId string UUID true User identifier
actionExternalUserId string false User external identifier
projectId string UUID true Project identifier
projectExternalId string false Project external identifier
data ChecklistNode true Created payload date

Example

{
  "type": "project_checklist_archived",
  "projectId": "310c5fda-906d-4f44-bf4d-a51d5ef55b99",  
  "projectExternalId": "1",
  "actionUserId": "110c5fda-226d-4f44-bf4d-a11d5ef55b33",
  "actionExternalUserId": "externalId",
  "data": {
    "id": "3f582b1f-0ea4-46aa-b6c2-03a68b8e7805",
    "parentId": "e5ac0f71-591f-4d1d-8373-f5a394e799ee",
    "name": "Some checklists update",
    "sfi": "2.22.00030",
    "progress": "50",
    "externalId": "1",
    "status": null,
    "dueDate": null,
    "hoursPlanned": null,
    "hoursSpent": null,
    "notes": null,
    "description": null,
    "relevantURL": null,
    "plannedStartDate": null,
    "startedAt": null,
    "completedAt": null,
    "verifiedAt": null
  }
}

project_checklist_comment_created

Payload data sent after Checklist Comment creation.

Properties

Property Type Format Required Description
type string true Payload type (project_checklist_comment_created)
actionUserId string UUID true User identifier
actionExternalUserId string false User external identifier
projectId string UUID true Project identifier
projectExternalId string false Project external identifier
data ChecklistComment true Created payload date

Example

{
  "type": "project_checklist_comment_created",
  "projectId": "310c5fda-906d-4f44-bf4d-a51d5ef55b99",
  "projectExternalId": "1",
  "actionUserId": "110c5fda-226d-4f44-bf4d-a11d5ef55b33",
  "actionExternalUserId": "externalId",
  "data": {
    "id": "3f582b1f-0ea4-46aa-b6c2-03a68b8e7805",
    "checklistId": "3f582b1f-0ea4-46aa-b6c2-03a68b8e7805",
    "comment": "comment"
  }
}

project_checklist_linked_item_added

Payload data sent after Checklist linked item is added.

List of entities that will trigger this webhook when assigned to Checklist:

  • Task
  • Issue
  • Document (linked and uploaded)
  • Image
  • Form
  • Pin
  • Comment
  • TimeCard

Properties

Property Type Format Required Description
type string true Payload type (project_checklist_linked_item_added)
actionUserId string UUID true User identifier
actionExternalUserId string false User external identifier
projectId string UUID true Project identifier
projectExternalId string false Project external identifier
data ChecklistResource true Created payload date

Example

{
  "type": "project_checklist_linked_item_added",
  "projectId": "310c5fda-906d-4f44-bf4d-a51d5ef55b99",
  "projectExternalId": "1",
  "actionUserId": "110c5fda-226d-4f44-bf4d-a11d5ef55b33",
  "actionExternalUserId": "externalId",
  "data": {
    "checklistId": "3f582b1f-0ea4-46aa-b6c2-03a68b8e7805",
    "resourceId": "3f582b1f-0ea4-46aa-b6c2-03a68b8e7805",
    "resourceType": "Image"
  }
}

project_checklist_linked_item_removed

Payload data sent after Checklist linked item is removed.

List of entities that will trigger this webhook when assigned to Checklist:

  • Task
  • Issue
  • Document (linked and uploaded)
  • Image
  • Pin
  • Comment
  • TimeCard

Properties

Property Type Format Required Description
type string true Payload type (project_checklist_linked_item_removed)
actionUserId string UUID true User identifier
actionExternalUserId string false User external identifier
projectId string UUID true Project identifier
projectExternalId string false Project external identifier
data ChecklistResource true Created payload date

Example

{
  "type": "project_checklist_linked_item_removed",
  "projectId": "310c5fda-906d-4f44-bf4d-a51d5ef55b99",
  "projectExternalId": "1",
  "actionUserId": "110c5fda-226d-4f44-bf4d-a11d5ef55b33",
  "actionExternalUserId": "externalId",
  "data": {
    "checklistId": "3f582b1f-0ea4-46aa-b6c2-03a68b8e7805",
    "resourceId": "3f582b1f-0ea4-46aa-b6c2-03a68b8e7805",
    "resourceType": "Image"
  }
}

results matching ""

    No results matching ""