Activities

Note:
Before using these API endpoints, learn more about how to use WixHive activities in your app.
GET/activities

Activities will be returned in descending order from the most recent Activity. The Activities by default are for the site the application is installed on, determined by the application-id and instance-id parameters/headers. Optionally results can be restricted to activities created by the current application. Results are returned in cursored form, and can be filtered by date ranges.

Parameters:

NameData TypeParameter TypeDescription

Example:

Response:

Here’s the full list of fields that can be part of the response.

The fields you’ll actually receive depend on the information you request and what we have in the system.

NameTypeDescription

Errors:

Here’s a list of possible error codes and when they occur. Read more about our API errors.

HTTP Status CodeReason/Error Message

GET/activities/{activityId}

Returns an Activity referenced by its ID, only relevant for the given site determined by the application-id and instance-id parameters/headers.

Parameters:

NameData TypeParameter TypeDescription

Example:

Response:

Here’s the full list of fields that can be part of the response.

The fields you’ll actually receive depend on the information you request and what we have in the system.

NameTypeDescription

Errors:

Here’s a list of possible error codes and when they occur. Read more about our API errors.

HTTP Status CodeReason/Error Message

GET/activities/types

Returns a list of Activity types that are currently supported by Wix. Each Activity type has an associated schema that data must conform to when posting Activities to Wix.

Parameters:

NameData TypeParameter TypeDescription

Example:

Response:

NameTypeDescription

Activity types:

Errors:

Here’s a list of possible error codes and when they occur. Read more about our API errors.

HTTP Status CodeReason/Error Message
GET/contacts/{contactId}/activities

Returns the Activity stream for a given Contact, referenced by the contact’s unique ID. Activities will be returned in descending order from the most recent Activity, in cursored form, and can be filtered by date ranges.

Parameters:

NameData TypeParameter TypeDescription

Example:

Response:

Here’s the full list of fields that can be part of the response.

The fields you’ll actually receive depend on the information you request and what we have in the system.

NameTypeDescription

Errors:

Here’s a list of possible error codes and when they occur. Read more about our API errors.

HTTP Status CodeReason/Error Message

POST/contacts/{contactId}/activities

This endpoint creates an Activity of a given activity type, adding the Activity directly to the specific contact. These Activity objects are then viewable in the site owner’s Dashboard. Each Activity conforms to a specific schema predefined by Wix. When the Activity is successfully created, the ID of the activity will be returned. If schema validation fails, or other errors occur, an error will be returned by this endpoint.

Parameters:

NameData TypeParameter TypeDescription

Example:

Response:

 

NameTypeDescription

Errors:

Here’s a list of possible error codes and when they occur. Read more about our API errors.

HTTP Status CodeReason / Error Message

Was this page helpful?

What can we do to improve it?

What did you like about it?