Before using these API endpoints, learn more about how to use WixHive activities in your app.
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:
activityTypes The activity types to filter against. Multiple activity types are seperated by a comma until Query The ending date for activities we want to return, as an ISO 8601 timestamp. This field is only relevant when a cursor is not present. from Query The beginning date for activities we want to return, as an ISO 8601 timestamp. This field is only relevant when a cursor is not present. scope Query cursor String Query The semi-optional cursor into the desired data. This cursor will expire after 30 minutes, it should not be cached. pageSize Query The number of results to return per page of data. Defaults to 25. version (required) Query The specific version of this endpoint. This version uses semantic versioning, in the form of major.minor.path application-id (required) String Query/ Header The application definition id. If sent through the header, this field must be prefixed with x-wix- instance-id (required) String Query/ Header The instance ID used for security validation with Wix. If sent through the header, this field must be prefixed with x-wix- signature (required) String Query/ Header The computed signature. If sent through the header, this field must be prefixed with x-wix- timestamp (required) Query/ Header The timestamp as an ISO 8601 timestamp. If sent through the header, this field must be prefixed with x-wix-Name Data Type Parameter Type Description String Query Datetime Datetime 'site'
By default, all activities for the site will be returnedInteger (1-500) Integer Datetime
Example:
|
1 2 3 4 5 6 7 8 9 10 |
{ "method": "GET", "url": "https://openapi.wix.com/v1/activities?version=1.0.0&activityTypes=form/contact-form&until=2017-03-26T13:48:42.220Z&pageSize=10", "headers": { "x-wix-application-id": "1462a46b-d417-e2a1-c95b-3d638d926904", "x-wix-instance-id": "dbb179ed-7ffd-4c21-951b-c38ab7d1c45b", "x-wix-timestamp": "2017-03-26T13:53:15.106Z", "x-wix-signature": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMT12" } } |
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.
pageSize Integer (1-500) Number of results returned per cursor previousCursor The cursor used to access the previous set of activities. null will be returned if there are no previous results nextCursor String The cursor used to access the next set of activities. null will be returned if there are no more results results Array of Activity items id String createdAt Timestamp indicating when this activity was created, as an ISO 8601 timestamp activityType String (see list of activity types) Type of activity performed activityLocationUrl String URL where the activity was performed activityDetails Relevant information about this activity to display in the Dashboard additionalInfoUrl String URL linking to more specific contextual information about the activity for use in the Dashboard summary String A short description about the activity for use in the Dashboard activityInfo Activity specific information related to this type of activity. This field must adhere to the schema specified by the activity type.Name Type Description String Array[Object] Activity ID Datetime Object Object
Errors:
Here’s a list of possible error codes and when they occur. Read more about our API errors.
Timestamp expired on the request, please submit again with a new timestamp. Cursor expired. The cursor is no longer valid. Please query again.HTTP Status Code Reason/Error Message 400 403 404 408 410
Returns an Activity referenced by its ID, only relevant for the given site determined by the application-id and instance-id parameters/headers.
Parameters:
activityId (required) The activity to get version (required) Query The specific version of this endpoint. This version uses semantic versioning, in the form of major.minor.path application-id (required) String The application definition id. If sent through the header, this field must be prefixed with x-wix- instance-id (required) String Query/ Header The instance ID used for security validation with Wix. If sent through the header, this field must be prefixed with x-wix- signature (required) String Query/ Header The computed signature. If sent through the header, this field must be prefixed with x-wix- timestamp (required) Query/ Header The timestamp as an ISO 8601 timestamp. If sent through the header, this field must be prefixed with x-wix-Name Data Type Parameter Type Description String Path Integer Query/ Header Datetime
Example:
|
1 2 3 4 5 6 7 8 9 10 |
{ "method": "GET", "url": "https://openapi.wix.com/v1/activities/6cbefa98-0345-4f2b-8bb4-a480d3f5008a?version=1.0.0", "headers": { "x-wix-application-id": "1462a46b-d417-e2a1-c95b-3d638d926904", "x-wix-instance-id": "dbb179ed-7ffd-4c21-951b-c38ab7d1c45b", "x-wix-timestamp": "2017-03-26T13:59:10.254Z", "x-wix-signature": "gMQmr3dQcB1knjd7si5dCEHubWOvEus0PtED3Vida90=" } } |
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.
id createdAt Timestamp indicating when this activity was created, as an ISO 8601 timestamp activityType String (see list of activity types) Type of activity performed activityLocationUrl String URL where the activity was performed activityDetails Relevant information about this activity to display in the Dashboard additionalInfoUrl String URL linking to more specific contextual information about the activity for use in the Dashboard summary String A short description about the activity for use in the Dashboard activityInfo Activity specific information related to this type of activity. This field must adhere to the schema specified by the activity type.Name Type Description String Activity ID Datetime Object Object
Errors:
Here’s a list of possible error codes and when they occur. Read more about our API errors.
Timestamp expired on the request, please submit again with a new timestamp. HTTP Status Code Reason/Error Message 400 403 404 408
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:
version (required) Query The specific version of this endpoint. This version uses semantic versioning, in the form of major.minor.path application-id (required) The application definition id. If sent through the header, this field must be prefixed with x-wix- instance-id (required) String Query/ Header signature (required) String Query/ Header timestamp (required) Query/ Header The timestamp as an ISO 8601 timestamp. If sent through the header, this field must be prefixed with x-wix-Name Data Type Parameter Type Description Integer String Query/ Header
If sent through the header, this field must be prefixed with x-wix-
If sent through the header, this field must be prefixed with x-wix-Datetime
Example:
|
1 2 3 4 5 6 7 8 9 10 |
{ "method": "GET", "url": "https://openapi.wix.com/v1/activities/types?version=1.0.0", "headers": { "x-wix-application-id": "1462a46b-d417-e2a1-c95b-3d638d926904", "x-wix-instance-id": "dbb179ed-7ffd-4c21-951b-c38ab7d1c45b", "x-wix-timestamp": "2017-03-26T14:00:30.160Z", "x-wix-signature": "ieCPqR-O6jrLOI6wjc5Ud-uE-6hye3UU0z9hsVtZlSE=" } } |
Response:
types An array of activity types currently supported by WixName Type Description Array[String]
Activity types:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
{ "types": [ "contacts/create", "e_commerce/cart-abandon", "e_commerce/cart-add", "e_commerce/cart-checkout", "e_commerce/cart-remove", "e_commerce/purchase", "events/rsvp", "form/contact-form", "form/form", "form/subscription-form", "hotels/cancel", "hotels/confirmation", "hotels/purchase", "hotels/purchase-failed", "hotels/reservation", "messaging/im", "music/album-fan", "music/album-played", "music/album-share", "music/track-lyrics", "music/track-play", "music/track-played", "music/track-share", "music/track-skip", "scheduler/appointment", "scheduler/cancel", "scheduler/confirmation", "social/comment", "social/share-url", "social/track", ] } |
Errors:
Here’s a list of possible error codes and when they occur. Read more about our API errors.
| HTTP Status Code | Reason/Error Message |
|---|---|
| 400 |
|
| 403 |
|
| 404 |
|
| 408 | Timestamp expired on the request, please submit again with a new timestamp. |
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:
contactId (required) The ID of the contact's stream to fetch activityTypes String (see list of activity types) The activity types to filter against. Multiple activity types are separated by a comma. until Query The ending date for activities we want to return, as an ISO 8601 timestamp. This field is only relevant when a cursor is not present. from Query The beginning date for activities we want to return, as an ISO 8601 timestamp. This field is only relevant when a cursor is not present scope Query The scope of the results to return, either for the entire site or limited to the current application. By default, all activities for the site will be returned cursor String Query The semi-optional cursor into the desired data. This cursor will expire after 30 minutes, it should not be cached. pageSize Integer (1-500) Query The number of results to return per page of data. Defaults to 25. version (required) Query The specific version of this endpoint. This version uses semantic versioning, in the form of major.minor.path application-id (required) String Query/ Header The application definition id. If sent through the header, this field must be prefixed with x-wix- instance-id (required) String Query/ Header The instance ID used for security validation with Wix. If sent through the header, this field must be prefixed with x-wix- signature (required) String Query/ Header The computed signature. If sent through the header, this field must be prefixed with x-wix- timestamp (required) Query/ Header The timestamp as an ISO 8601 timestamp. If sent through the header, this field must be prefixed with x-wix-Name Data Type Parameter Type Description String Path Query Datetime Datetime 'site' Integer Datetime
Example:
|
1 2 3 4 5 6 7 8 9 10 |
{ "method": "GET", "url": "https://openapi.wix.com/v1/contacts/0126c839-2344-47d6-b219-1441b30d1a8b/activities?version=1.0.0", "headers": { "x-wix-application-id": "1462a46b-d417-e2a1-c95b-3d638d926904", "x-wix-instance-id": "dbb179ed-7ffd-4c21-951b-c38ab7d1c45b", "x-wix-timestamp": "2017-03-26T14:01:51.914Z", "x-wix-signature": "EBB0T_9rEyKRBys5eCaQRhO8Q6yriSIYifj0UKvy464=" } } |
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.
pageSize Integer (1-500) The number of results returned per cursor previousCursor String The cursor used to access the previous set of activities. null will be returned if there are no previous results. nextCursor String The cursor used to access the next set of activities. null will be returned if there are no more results. results An array of Activity items id String createdAt Datetime Timestamp indicating when this activity was created, as an ISO 8601 timestamp activityType String (see list of activity types) Type of activity performed activityLocationUrl String URL where the activity was performed activityDetails Relevant information about this activity to display in the Dashboard additionalInfoUrl String url linking to more specific contextual information about the activity for use in the Dashboard summary String A short description about the activity for use in the Dashboard activityInfo Activity specific information related to this type of activity. This field must adhere to the schema specified by the activity type.Name Type Description Array[Object] The activity ID Object Object
Errors:
Here’s a list of possible error codes and when they occur. Read more about our API errors.
Timestamp expired on the request, please submit again with a new timestamp. Cursor expired. The cursor is no longer valid. Please query again.HTTP Status Code Reason/Error Message 400 403 404 408 410
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:
contactId (required) The ID of the target Contact version (required) Query The specific version of this endpoint. This version uses semantic versioning, in the form of major.minor.path application-id (required) String The application definition id. If sent through the header, this field must be prefixed with x-wix- instance-id (required) String Query/ Header The instance ID used for security validation with Wix. If sent through the header, this field must be prefixed with x-wix- signature (required) String Query/ Header The computed signature. If sent through the header, this field must be prefixed with x-wix- timestamp (required) Datetime Query/ Header activity (required) Object The Activity to create createdAt (required) Body Timestamp indicating when this activity was created, as an ISO 8601 timestamp activityType (required) String (see list of activity types) Body Type of activity performed activityLocationUrl String Body URL where the activity was performed activityDetails Body Relevant information about this activity to display in the Dashboard additionalInfoUrl (required) String Body URL linking to more specific contextual information about the activity for use in the Dashboard summary (required) String Body A short description about the activity for use in the Dashboard activityInfo (required) Body Activity specific information related to this type of activity. This field must adhere to the schema specified by the activity type.Name Data Type Parameter Type Description String Path Integer Query/ Header
If sent through the header, this field must be prefixed with x-wix-Body Datetime Object Object
Example:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
{ "method": "POST", "url": "https://openapi.wix.com/v1/contacts/0126c839-2344-47d6-b219-1441b30d1a8b/activities?version=1.0.0", "headers": { "x-wix-application-id": "1462a46b-d417-e2a1-c95b-3d638d926904", "x-wix-instance-id": "dbb179ed-7ffd-4c21-951b-c38ab7d1c45b", "x-wix-timestamp": "2017-03-26T14:09:09.668Z", "x-wix-signature": "qklWQibm57XNToJlLZkPwhZJZ6NbUHgMkzezZKbDeIA=" }, "json": true, "body": { "createdAt": "2017-03-26T14:01:51.914Z", "activityType": "hotels/cancel", "activityLocationUrl": "http://google.com", "activityInfo": { "cancelDate": "2017-03-26T14:07:33.734Z", "refund": { "kind": "FULL", "total": 100, "currency": "USD", "notes": "too expensive", "destination": "Tel Aviv" }, "reservationId": "455", "guests": { "total": 1, "adults": 1, "children": 0 }, "stay": { "checkin": "2017-03-26T14:06:07.334Z", "checkout": "2017-03-26T14:07:33.734Z" }, "rates": [ { "date": "2017-03-26T14:06:07.334Z", "subtotal": 22.4, "taxes": [ { "name": "stuff", "total": 0.6, "currency": "USD" } ], "total": 30, "currency": "USD" } ], "invoice": { "subtotal": 20, "total": 30, "currency": "UDS" }, "customer": { "contactId": "123", "isGuest": true, "name": { "prefix": "Mr", "first": "Kanye", "middle": "k", "last": "West", "suffix": "The king" }, "phone": "1234567", "email": "email@email.com" }, "rooms": [ { "id": "single123", "beds": [ { "kind": "king" } ], "maxOccupancy": 3, "amenities": [ "air conditioning", "wifi", "cable", "goats" ] } ] } } } |
Response:
activityId contactIdName Type Description String Activity ID String Contact ID
Errors:
Here’s a list of possible error codes and when they occur. Read more about our API errors.
Timestamp expired on the request, please submit again with a new timestamp.HTTP Status Code Reason / Error Message 400 403 404 408