Skip to main content
POST
/
webhooks
/
tasks
{
  "body": {
    "action_type": "Assistance",
    "assignee_id": null,
    "attachments": {
      "file_A": "https://u.dev.hiadam.co/pi5fwe3"
    },
    "completed_datetime": null,
    "creator": {
      "email": "[email protected]",
      "unit_external_ref": "P~4770692~467~2016",
      "lease_external_ref": "A1234",
      "first_name": "Bob",
      "last_name": "James",
      "phone_number": "+447549111111",
      "resident_address": "10 Executive Park West NE",
      "unit_identifier": "4efdccb7-10ca-47b0-811c-de2fae9f6682",
      "unit_number": "2016"
    },
    "datetime_created": "2023-12-20T17:32:49.143000+00:00",
    "datetime_updated": "2024-01-15T15:07:27.440000+00:00",
    "description": "a description",
    "due_datetime": "2023-12-19T12:00:00+00:00",
    "external_ref": "1234567890",
    "identifier": "26d2f5f9-b128-48cd-add8-303e067df958",
    "importance": "very_high",
    "notes": null,
    "portfolio_external_ref": "P1234",
    "portfolio_id": "b0234194-e61b-4a57-967f-6eaaee4d5219",
    "priority_score": 500,
    "queue_name": null,
    "relevant_conversation": null,
    "reminder_datetime": null,
    "resident_id": null,
    "status": "created",
    "category": "Customer Support",
    "summary": "a summary",
    "title": "a title",
    "onsite_indicator": "onsite",
    "topic": "maintenance",
    "user_goal": "fix_shower",
    "escalation_flag": false
  },
  "event_type": "task.update",
  "message_id": "51d155b3-496f-434e-b664-406836be35a0"
}
The task webhook allows you to subscribe to task events, the creation, update and deletion of tasks.

​
Overview

A webhook event payload includes two top-level fields:
  • event_type: identifies the type of event (e.g., task.create, task.update, task.delete).
  • message_id: a unique identifier for the webhook delivery.
  • body: an object containing the task data.

​
Event Metadata

FieldTypeDescriptionExample
event_typestringType of webhook event. Possible values: task.create, task.update, task.delete."task.update"
message_idstring (UUID)Unique identifier for this webhook message. Used for idempotency and deduplication."51d155b3-496f-434e-b664-406836be35a0"

​
Task Body Fields

FieldTypeDescriptionExample
identifierstring (UUID)Travtus internal identifier of the task. Used for update or retrieval."26d2f5f9-b128-48cd-add8-303e067df958"
external_refstringClient’s external reference for the task."1234567890"
action_typestringFree text field describing the type of action requested (e.g., “Assistance”)."Assistance"
titlestringTitle or short name of the task."a title"
summarystringSummary of the task’s scope.

N.B. this field does not have a character limit.		"a summary"
descriptionstringDetailed explanation of the task."a description"
categorystringThe category of the task. Independent from topic."Customer Support"
topicstringThe topic of the conversation or request that created the task."maintenance"
user_goalstringThe specific intent or objective expressed by the user."fix_shower"
importanceenumImportance level of the task. One of: low, normal, high, very_high."very_high"
priority_scoreinteger (0–1000)Numeric priority value for sorting or SLA weighting.500
statusenumCurrent task state. One of: created, in_progress, completed, deleted."created"
queue_nameenum or nullDepartment or work queue responsible for the task. One of: Accounts, Collections, Facilities, Leasing, Legal, Off-Boarding, Onboarding, Public Safety, Renewals, Retention, Services, Technology.null
onsite_indicatorenumIndicates whether onsite expertise is required. One of: onsite, offsite."onsite"
attachmentsobjectURLs of attachments related to the task, keyed by file label.{"file_A": "https://u.dev.hiadam.co/pi5fwe3"}
notesstring or nullAdditional free-text notes.null
escalation_flagbooleanTrue if the task is an escalation due to severity or delay.false
due_datetimedatetimeWhen the task is due."2023-12-19T12:00:00+00:00"
reminder_datetimedatetime or nullWhen a reminder should be triggered.null
completed_datetimedatetime or nullWhen the task was completed.null
datetime_createddatetimeWhen the task record was created. System-generated."2023-12-20T17:32:49.143000+00:00"
datetime_updateddatetimeWhen the task record was last modified. System-generated."2024-01-15T15:07:27.440000+00:00"
relevant_conversationstring or nullTranscript of the conversation that led to task creation.null
portfolio_idstring (UUID)Travtus internal ID for the community/portfolio."b0234194-e61b-4a57-967f-6eaaee4d5219"
portfolio_external_refstringClient’s external reference for the community/portfolio."P1234"
unit_identifierstring (UUID)Travtus internal identifier for the housing unit."4efdccb7-10ca-47b0-811c-de2fae9f6682"
unit_numberstringClient-visible unit number."2016"
lease_external_refstringClient’s external reference for the lease."A1234"
resident_addressstringAddress of the resident’s housing unit."10 Executive Park West NE"
resident_idstring (UUID) or nullTravtus internal identifier for the resident.null
assignee_idstring (UUID) or nullTravtus internal identifier of the person assigned to the task.null

​
Creator Object

The creator field contains information about the individual or system that created the task.
FieldTypeDescriptionExample
emailstringCreator’s email address."[email protected]"
first_namestringCreator’s first name."Bob"
last_namestringCreator’s last name."James"
phone_numberstringCreator’s phone number in E.164 format."+447549111111"
unit_external_refstringClient’s external reference for the unit."P~4770692~467~2016"
lease_external_refstringClient’s external reference for the lease."A1234"
resident_addressstringAddress of the resident’s housing unit."10 Executive Park West NE"
unit_identifierstring (UUID)Travtus internal identifier of the unit."4efdccb7-10ca-47b0-811c-de2fae9f6682"
unit_numberstringThe visible or client-facing unit number."2016"

​
Relationships and Behavior

  • identifier or external_ref can be used to reference or update a task.
  • topic and user_goal are related conceptually, where user_goal expresses the intent arising from a topic.
  • category, topic, and queue_name are independent classification fields.
  • importance, priority_score, and onsite_indicator influence task routing and SLA handling.
  • portfolio_id / portfolio_external_ref and unit_identifier provide context about where the task applies.
  • creator fields document the originator of the task.
{
  "body": {
    "action_type": "Assistance",
    "assignee_id": null,
    "attachments": {
      "file_A": "https://u.dev.hiadam.co/pi5fwe3"
    },
    "completed_datetime": null,
    "creator": {
      "email": "[email protected]",
      "unit_external_ref": "P~4770692~467~2016",
      "lease_external_ref": "A1234",
      "first_name": "Bob",
      "last_name": "James",
      "phone_number": "+447549111111",
      "resident_address": "10 Executive Park West NE",
      "unit_identifier": "4efdccb7-10ca-47b0-811c-de2fae9f6682",
      "unit_number": "2016"
    },
    "datetime_created": "2023-12-20T17:32:49.143000+00:00",
    "datetime_updated": "2024-01-15T15:07:27.440000+00:00",
    "description": "a description",
    "due_datetime": "2023-12-19T12:00:00+00:00",
    "external_ref": "1234567890",
    "identifier": "26d2f5f9-b128-48cd-add8-303e067df958",
    "importance": "very_high",
    "notes": null,
    "portfolio_external_ref": "P1234",
    "portfolio_id": "b0234194-e61b-4a57-967f-6eaaee4d5219",
    "priority_score": 500,
    "queue_name": null,
    "relevant_conversation": null,
    "reminder_datetime": null,
    "resident_id": null,
    "status": "created",
    "category": "Customer Support",
    "summary": "a summary",
    "title": "a title",
    "onsite_indicator": "onsite",
    "topic": "maintenance",
    "user_goal": "fix_shower",
    "escalation_flag": false
  },
  "event_type": "task.update",
  "message_id": "51d155b3-496f-434e-b664-406836be35a0"
}