The Templates API gives you access to the catalog of activity templates and categories used by the
Activities API.
Templates are predefined formats that Wix uses to record activities automatically: they define the
message wording, with placeholders for relevant details, an optional icon, and optional links.
Every activity created from a template produces a consistent, recognizable message.
With the Templates API, you can:
- Browse available templates to understand what kinds of activities Wix records automatically
for a contact. Retrieve template details such as
activityDescription and icon to enrich the
display of activities in a contact's log.
- Browse available categories to understand how templates are organized and to get category IDs
for filtering a contact's activity history by type in
List Activities.
Templates and categories are provided by Wix and can't be created, edited, or deleted through
the API.
Each template defines how an activity's message is composed:
- Name: A constant display name for the template, not translated.
- Activity description: A translated description of what the template records, without
parameter placeholders (for example, "Purchased tickets to an event"). Not present for all
templates.
- Params: Named placeholders that define what values are used when composing the activity's
message. Each param key corresponds to a key in
activity.params for activities created from
this template. If an activity_key param is present, it is for internal use.
- Links: Optional structured URLs associated with the template. A link's key can appear as a
placeholder in the template's message, and its URL can itself contain param placeholders — for
example,
https://example.com/orders/{{orderId}}. Links are embedded as plain text in the
rendered activity.message.
- Icon: An image representing the template. Use
icon.url to display the icon.
- Template: A predefined format that Wix uses to record activities automatically. Defines the
message wording, with placeholders for relevant details, optional links, and an icon.
- Category: A grouping of related templates. Use a category ID to filter which templates are
shown or to filter a contact's activity history by type.
- Parameter: A named placeholder in a template's wording. Values for each parameter are stored
in
activity.params for activities created from this template.
- Activity description: A translated description of what the template records, without
parameter placeholders.