Activities API: Sample Flows

This article presents possible use cases and corresponding sample flows that you can support. It provides a useful starting point as you plan your implementation.

Record a custom activity

When you want to log something that happened with a contact, use a free-text custom activity. A custom activity carries a message you write yourself. Wix records it using a Generic template under the "Other apps" category.

To record a custom activity:

1. Call Create Custom Activity with:
   • contactId: the contact this activity belongs to.
   • message: a free-text description of what happened.
   • activityDate: when the event occurred.

Display a contact's activity timeline

Your app shows a contact's full history on their detail page, displaying what happened over time in chronological order: messages sent, subscription changes, and other recorded events.

To display a contact's activity timeline:

1. Call List Activities with the contact's ID. Omit cursorPaging on the first call. Optionally pass categoryId, fromDate, or toDate to narrow the results.
2. Render the returned activities. Each activity has an activityDate to use as the timeline timestamp and a message to display.
3. Check whether metadata.cursors.next is present in the response. If it is, call List Activities again with only cursorPaging.cursor set to metadata.cursors.next. Don't pass any other fields when using a cursor.
4. Append the new activities to your timeline and repeat step 3 until metadata.cursors.next is empty.
5. Optionally enrich activities that have a templateId by matching them against List Templates results to display the template's icon and category.