Understanding tasks
Core purpose
Tasks provide a structured way to manage work items, ensuring that all account-related activities are properly tracked, assigned, and completed. They help maintain accountability and drive customer success initiatives forward.
Task categories
Customer tasks
• Follow-up calls
• Account reviews
• Training sessions
• Issue resolution
• Account reviews
• Training sessions
• Issue resolution
Internal tasks
• Team updates
• Resource allocation
• Process reviews
• Documentation updates
• Resource allocation
• Process reviews
• Documentation updates
Standard fields
Required fields
| Name | Type | Options | Comments |
|---|---|---|---|
| Account ID | string | Required | Associated account identifier |
| Title | string | Required | Task title |
| Assignee ID | string | Required | ID of assigned user |
Optional fields
| Name | Type | Options | Comments |
|---|---|---|---|
| Activity ID | string | Optional | Related activity reference |
| Description | string | Optional | Detailed task description |
| Type | string | Optional, Values: [FOLLOW_UP (default), REVIEW, APPROVAL, CUSTOM] | Task type reference |
| Status | string | Optional, Values: [PENDING (default), IN_PROGRESS, COMPLETED, CANCELLED] | Task status reference |
| Priority | string | Optional, Values: [LOW (default), MEDIUM, HIGH] | Task priority reference |
| Attachment URLs | array | Optional | List of attachment URLs |
System-managed fields
| Name | Type | Options | Comments |
|---|---|---|---|
| Task ID | bigserial | Auto-generated | Primary key |
| UID | text | Auto-generated | Unique identifier (ULID) |
| Is Active | boolean | Default: true | Task’s active status |
| Created By | bigint | Auto-populated | References user table |
| Created At | timestamp | Auto-populated | Creation timestamp with timezone |
| Updated At | timestamp | Auto-populated | Last update timestamp with timezone |
| Deleted At | timestamp | Optional | Soft delete timestamp with timezone |
Database types:
- Account ID, Activity ID, Assignee ID, Type, Status, Priority are stored as
bigintin the database - Title and Description are stored as
text - System fields use their respective database types (
bigserial,text,boolean,timestamp with time zone)
Task workflow
1
Creation
- Define clear objective
- Set priority level
- Assign ownership
- Establish timeline
2
Execution
- Track progress
- Update status
- Document blockers
- Manage dependencies
3
Completion
- Verify deliverables
- Document outcomes
- Create follow-ups
- Update stakeholders
Best practices
Task management
• Set clear deadlines
• Define ownership
• Track dependencies
• Monitor progress
• Define ownership
• Track dependencies
• Monitor progress
Collaboration
• Communicate updates
• Share context
• Escalate blockers
• Document decisions
• Share context
• Escalate blockers
• Document decisions
API endpoints
Sample task
When creating a task, the system will add additional fields in the response such as:
id: Unique identifier for the taskaccount: Name of the associated accountcreator: Name of the task creatorcreatorId: ID of the creatorcreatorEmail: Email of the creatorisActive: Whether the task is activecreatedAt: Creation timestampupdatedAt: Last update timestamp
Available operations
Task management
Task management
All endpoints require authentication with Bearer token, API key, and Organization ID in the headers.