Activities

Push notifications and activity feed that link to resources inside of the mobile and desktop applications. Activities keep users informed of important events and updates in real-time.

Activities can be associated to a Contact.

Rules

• When an Activity is created, the User is notified via push notification
• When the User swipes the push notification, it links to that Activity detail
• If the Activity has a relation (polymorphic), it will show up in the Activity detail
  • Relation types: media, library, event, task, contact, note, product, page
• Separately, Activities can be linked to a person: contact, visitor, customer
• If an Activity is associated to a Contact, Visitor, or Customer, it will show up on that person's detail page

JSON Structure

{
  "id": 12345,
  "user_id": 67890,
  "company_id": 11111,
  "contact_id": 22222,
  "visitor_id": null,
  "relation_type": "product",
  "relation_id": 33333,
  "title": "New order placed",
  "description": "Jane Smith placed an order for $150.00",
  "formatted_description": "<strong>Jane Smith</strong> placed an order for $150.00",
  "slug": "order_placed",
  "read_at": null,
  "created_at": "2025-01-15T10:30:00Z"
}

API Endpoints

Company Scoped

User Scoped

Read / Unread Status

• Users can mark Activities as unread if they want to revisit them later
• By default, when a User visits the Activities index screen, all unread Activities are automatically marked as read
• The read_at field will be null for unread Activities and contain a timestamp when read

Best Practices

Note: Because Activities always create a push notification (Desktop and Mobile where applicable), they should not be overused or the signal will turn to noise. Use Activities sparingly for important, actionable updates that genuinely require the user's attention.

Next Steps

• Review the Core Elements Overview for API access patterns
• See Use Cases for examples of Activities in workflows
• Explore the User API Reference for detailed endpoint documentation