Go Headless

Build Apps

Client

API Preview

test

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

# About Social Media

The Social Media API allows you to track when a loyalty customer follows a social media channel. After following a social media channel, the customer's loyalty account receives some loyalty points.

With the Social Media API, you can:

- [Add](fallback::https://dev.wix.com/docs/rest/crm/loyalty-program/social-media/create-followed-channel) a new channel to an account's followed channels.
- [List](fallback::https://dev.wix.com/docs/rest/crm/loyalty-program/social-media/list-followed-channels) all social media channels of a member.

## Before you begin

- Install the [Wix Loyalty Program](fallback::https://www.wix.com/app-market/web-solution/loyalty) app from the App Market.
- Members can only follow enabled channels. A site owner has to enable channels in the dashboard.

## Use cases

- [Sync followed social media channels and loyalty points with an external system](fallback::https://dev.wix.com/docs/rest/crm/loyalty-program/social-media/sample-use-cases-and-flows)

## Terminology

- **Social Media**: Online platforms and applications that enable users to create, share, and engage with content, as well as interact with others through communication, collaboration, and networking. For example, Facebook, Instagram, Twitter, and LinkedIn.
- **Loyalty Points**: Type of reward system used by businesses to encourage customer engagement and retention. Customers earn points based on their purchases or specific actions, such as referrals or social media engagement. These points can typically be redeemed for discounts, free products, or exclusive benefits, fostering brand loyalty and repeat business.

# Social Media: Sample Use Cases and Flows

This article shares some possible use cases your app could support, as well as a sample flow that could support each use case. This can be a helpful jumping off point as you plan your app's implementation.

## Sync followed social media channels and loyalty points with an external system

If multiple Wix sites use your app with a loyalty program, you can synchronize followed social media channels and loyalty points across these sites. This synchronization ensures consistency, eliminates manual updates, and reduces the risk of data discrepancies.

To perform an initial upload and update all social media channels with associated loyalty points from a Wix site to your external system, follow these steps:

- Initial setup
- Synchronize to the external system

### Part 1: Initial setup

1. Create a custom field in your system. Add a field in your external system to store the followed social media record ID and loyalty points for each account ID. Ensure your code prevents this record ID from being overwritten by future updates.
1. Create a mapping between the site's followed social media record and loyalty points fields and the corresponding fields in your external system. This mapping will be used whenever records are synchronized.
1. Call [List Followed Channels](fallback::https://dev.wix.com/docs/rest/crm/loyalty-program/social-media/list-followed-channels) to retrieve all followed social media channels for the relevant account. Call [Get Account](fallback::https://dev.wix.com/docs/rest/crm/loyalty-program/accounts/get-account) to fetch account details, including loyalty points. Send the `channels` and `points` fields to the external system.

### Part 2: Synchronize to the external system

1. On an ongoing basis, monitor the following webhooks to detect updates to followed social media records and loyalty points:

    - [Followed Channel Created](fallback::https://dev.wix.com/docs/rest/crm/loyalty-program/social-media/followed-channel-created)
    - [Points Updated](fallback::https://dev.wix.com/docs/rest/crm/loyalty-program/accounts/points-updated)

1. When the above webhooks are triggered, retrieve the record and loyalty points from the payload. Use the predefined mapping to update the external system with the new information.

identityType

IdentificationData

WebhookIdentityType

ID of a site visitor that has not logged in to the site.

anonymousVisitorId

appId

ID of a site visitor that has logged in to the site.

memberId

ID of a Wix user (site owner, contributor, etc.).

wixUserId

data

eventType

The identification type and identity data.

instanceId

MessageEnvelope

Type

value

BoolValue

Empty

Int64Value

values

ListValue

NullValue

StringValue

fields

Struct

nanos

seconds

Timestamp

Value

boolValue

listValue

nullValue

numberValue

stringValue

structValue

kind

bodyAsJson

ActionEvent

A sequence number defining the order of updates to the underlying entity.
For example, given that some entity was updated at 16:00 and than again at 16:01,
it is guaranteed that the sequence number of the second update is strictly higher than the first.
As the consumer, you can use this value to ensure that you handle messages in the correct order.
To do so, you will need to persist this number on your end, and compare the sequence number from the
message against the one you have stored. Given that the stored number is higher, you should ignore the message.

entityEventSequence

Assumes actions are also always typed to an entity_type
Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction

entityFqdn

ID of the entity associated with the event.

entityId

Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z

eventTime

Unique event ID.
Allows clients to ignore duplicate webhooks.

If present, indicates the action that triggered the event.

originatedFrom

This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
This is although the created/updated/deleted notion is duplication of the oneof types
Example: created/updated/deleted/started/completed/email_opened

slug

Whether the event was triggered as a result of a privacy regulation application
(for example, GDPR).

triggeredByAnonymizeRequest

DomainEvent

body

entityAsJson

Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity

EntityCreatedEvent

deletedEntityAsJson

EntityDeletedEvent

Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.

currentEntityAsJson

EntityUpdatedEvent

deletedDate

RestoreInfo

CreateFollowedChannelRequest

CreateFollowedChannelResponse

ID of the account that has followed a social media channel.

accountId

channel

Date when an entity for following a social media channel was created.

createdDate

FollowedChannel

ListFollowedChannelsRequest

followedChannels

ListFollowedChannelsResponse

Retrieves a list of social media channels followed by the account. The list is ordered by creation date.

>**Note:**
>This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).

Manage Loyalty

Read Loyalty

List followed social media channels

ListFollowedChannels

Creates an entity for the specified account ID when the account follows a social media channel.

Members can only follow enabled channels. A site owner has to enable channels in the dashboard.

>**Note:**
>This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).

Followed Channel Object