Understanding activities
Core purpose
Activities provide a structured way to track, manage, and analyze all customer interactions. They help maintain a complete history of engagements and ensure proper follow-up on customer communications.
Activity types
Communication activities
• Meetings: In-person or virtual
• Calls: Phone conversations
• Emails: Email threads
• Chat: Instant messaging
• Calls: Phone conversations
• Emails: Email threads
• Chat: Instant messaging
Business activities
• Site visits: On-premise meetings
• Reviews: Performance discussions
• Presentations: Product demos
• Training: Customer education
• Reviews: Performance discussions
• Presentations: Product demos
• Training: Customer education
Standard fields
Required fields
| Name | Type | Options | Comments |
|---|---|---|---|
| Account ID | string | Required | Associated account identifier |
| Activity Timestamp | timestamp | Required | When the activity occurred |
| Duration | integer | Required | Length of activity in minutes |
| Location | string | Required | Physical or virtual location |
Optional fields
| Name | Type | Options | Comments |
|---|---|---|---|
| Type | string | Optional, Values: [CALL (default), EMAIL, MEETING, SITE_VISIT] | Activity type reference |
| Status | string | Optional, Values: [PENDING (default), COMPLETED, CANCELLED] | Activity status reference |
| Participants | jsonb | Optional, Default: [] | List of participants |
| Attachment URLs | array | Optional | List of attachment URLs |
System-managed fields
| Name | Type | Options | Comments |
|---|---|---|---|
| Activity ID | bigserial | Auto-generated | Primary key |
| UID | text | Auto-generated | Unique identifier (ULID) |
| Is Active | boolean | Default: true | Activity’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 and Created By are stored as
bigintin the database - Location is stored as
text - Duration is stored as
integer - Participants is stored as
jsonb - System fields use their respective database types (
bigserial,text,boolean,timestamp with time zone)
Activity tracking
1
Planning
- Schedule activities
- Set clear objectives
- Identify participants
- Prepare required materials
2
Execution
- Record attendance
- Document key points
- Track action items
- Note decisions made
3
Follow-up
- Update activity status
- Create follow-up tasks
- Share meeting notes
- Schedule next steps
Best practices
Documentation
• Record activities promptly
• Include all relevant details
• Link to related records
• Maintain consistent format
• Include all relevant details
• Link to related records
• Maintain consistent format
Organization
• Use clear subject lines
• Categorize properly
• Tag all participants
• Set appropriate privacy
• Categorize properly
• Tag all participants
• Set appropriate privacy
API endpoints
Sample activity
When creating an activity, the system will add additional fields in the response such as:
id: Unique identifier for the activityaccount: Name of the associated accountcreator: Name of the activity creatorcreatorId: ID of the creatorcreatorEmail: Email of the creatorcreatedAt: Creation timestampupdatedAt: Last update timestamp
Available operations
Activity management
Activity management
All endpoints require authentication with Bearer token, API key, and Organization ID in the headers.