About the Contacts Activity Log APIs

The Activity Log APIs let you work with a contact's activity log: a permanent, timestamped record of what has happened with that contact over time. Each entry describes a single event, such as a message sent, a booking canceled, a form submitted, or any other moment worth recording. Together, a contact's activities tell the story of your relationship with them.

With the Activity Log APIs, you can:

• Activities: Record custom activities for a contact with a free-text message, retrieve a contact's full activity history with filtering and cursor-based paging, and react to new activities in real time using the ActivityCreated domain event.
• Templates: Browse the catalog of templates that Wix uses to record activities automatically, and retrieve category IDs to filter a contact's activity history by type.

How the APIs work together

Activities are the core of the log. Wix records some activities automatically from templates (for example, when a contact books a session or subscribes to a newsletter). You can also record custom activities yourself, with a free-text message describing what happened.

The Templates API is a companion that helps you understand and display those template-based activities. Use it to look up an activity's icon and translated description, or to retrieve category IDs for filtering.

Terminology

• Activity: A single dated entry in a contact's activity log, describing something that happened.
• Activity log: The full collection of activities for one contact, ordered from most recent to oldest.
• Template: A predefined format that Wix uses to create consistent activity entries. Defines the message wording, an optional icon, and optional links.
• Category: A grouping of related templates. Use a category ID to filter a contact's activities by type.
• Custom activity: A free-text activity you create with the Create Custom Activity method, using any message you choose.