# Introduction

The Members Follow API allows site members to follow and unfollow each other. When a site member follows another member, they receive activity notifications from the members they follow.

With the Members Followers API, you can:

- Let members [follow](fallback::https://dev.wix.com/docs/sdk/backend-modules/members/member-followers/follow-member) or [unfollow](fallback::https://dev.wix.com/docs/sdk/backend-modules/members/member-followers/unfollow-member) each other.
- List who a site member [follows](fallback::https://dev.wix.com/docs/sdk/backend-modules/members/member-followers/list-current-member-following) or is [followed](fallback::https://dev.wix.com/docs/sdk/backend-modules/members/member-followers/list-current-member-followers) by.

@package_metadata:@wix/members

To use the MemberFollowers API, install the `@wix/members` package.

#### Install the package

Follow the installation instructions for your development environment.

| Development environment | Installation method |
|--|--|
| Wix sites (editor or IDE) | Use the [package manager](fallback::https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-in-the-editor). |
| Wix sites (local IDE) | Run `wix install @wix/members` using the [Wix CLI](fallback::https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-with-the-wix-cli).|
| Blocks apps | Use the same installation method as Wix sites. |
| CLI and self-hosted apps | Run `npm install @wix/members` or `yarn add @wix/members`. |
| Headless sites and apps | Run `npm install @wix/members` or `yarn add @wix/members`. |

#### Import the package

To import the package in your code:

```js
import { memberFollowers } from '@wix/members'
```

Coding Examples

Sled Tests

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

API Reference

Velo

Picasso

GraphQL (Alpha)

MemberFollowers

Member Followers 1 0 0

memberId

string

Sets the current member to follow another, specified member.

import { memberFollowers } from '@wix/members';

async function followMember(memberId) {
  const response = await memberFollowers.followMember(memberId);
};

followMember

import { createClient } from '@wix/sdk';
import { memberFollowers } from '@wix/members';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { memberFollowers },
  // Include the auth strategy and host as relevant
});


async function followMember(memberId) {
  const response = await myWixClient.memberFollowers.followMember(memberId);
};

Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).

followMember (self-hosted)

void

options

ListCurrentMemberFollowersOptions

Retrieves a list of members who are following the current member.

import { memberFollowers } from '@wix/members';

async function listCurrentMemberFollowers(options) {
  const response = await memberFollowers.listCurrentMemberFollowers(options);
};

listCurrentMemberFollowers

import { memberFollowers } from '@wix/members';
import { auth } from '@wix/essentials';

async function myListCurrentMemberFollowersMethod(options) {
  const elevatedListCurrentMemberFollowers = auth.elevate(memberFollowers.listCurrentMemberFollowers);
  const response = await elevatedListCurrentMemberFollowers(options);
}

listCurrentMemberFollowers (with elevated permissions)

import { createClient } from '@wix/sdk';
import { memberFollowers } from '@wix/members';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { memberFollowers },
  // Include the auth strategy and host as relevant
});


async function listCurrentMemberFollowers(options) {
  const response = await myWixClient.memberFollowers.listCurrentMemberFollowers(options);
};

listCurrentMemberFollowers (self-hosted)

ListCurrentMemberFollowersResult

ListCurrentMemberFollowingOptions

Retrieves a list of members who are followed by the current member.

import { memberFollowers } from '@wix/members';

async function listCurrentMemberFollowing(options) {
  const response = await memberFollowers.listCurrentMemberFollowing(options);
};

listCurrentMemberFollowing

import { memberFollowers } from '@wix/members';
import { auth } from '@wix/essentials';

async function myListCurrentMemberFollowingMethod(options) {
  const elevatedListCurrentMemberFollowing = auth.elevate(memberFollowers.listCurrentMemberFollowing);
  const response = await elevatedListCurrentMemberFollowing(options);
}

listCurrentMemberFollowing (with elevated permissions)

import { createClient } from '@wix/sdk';
import { memberFollowers } from '@wix/members';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { memberFollowers },
  // Include the auth strategy and host as relevant
});


async function listCurrentMemberFollowing(options) {
  const response = await myWixClient.memberFollowers.listCurrentMemberFollowing(options);
};

listCurrentMemberFollowing (self-hosted)

ListCurrentMemberFollowingResult

ID of the member whose followed members to list.

ListMemberFollowersOptions

Retrieves a list of members who are following the given member.

import { memberFollowers } from '@wix/members';

async function listMemberFollowers(memberId, options) {
  const response = await memberFollowers.listMemberFollowers(memberId, options);
};

listMemberFollowers

import { memberFollowers } from '@wix/members';
import { auth } from '@wix/essentials';

async function myListMemberFollowersMethod(memberId, options) {
  const elevatedListMemberFollowers = auth.elevate(memberFollowers.listMemberFollowers);
  const response = await elevatedListMemberFollowers(memberId, options);
}

listMemberFollowers (with elevated permissions)

import { createClient } from '@wix/sdk';
import { memberFollowers } from '@wix/members';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { memberFollowers },
  // Include the auth strategy and host as relevant
});


async function listMemberFollowers(memberId, options) {
  const response = await myWixClient.memberFollowers.listMemberFollowers(memberId, options);
};

listMemberFollowers (self-hosted)

ListMemberFollowersResult

ID of the member whose followers to list.

ListMemberFollowingOptions

Retrieves a list of members who are followed by the given member.

import { memberFollowers } from '@wix/members';

async function listMemberFollowing(memberId, options) {
  const response = await memberFollowers.listMemberFollowing(memberId, options);
};

listMemberFollowing

import { memberFollowers } from '@wix/members';
import { auth } from '@wix/essentials';

async function myListMemberFollowingMethod(memberId, options) {
  const elevatedListMemberFollowing = auth.elevate(memberFollowers.listMemberFollowing);
  const response = await elevatedListMemberFollowing(memberId, options);
}

listMemberFollowing (with elevated permissions)

import { createClient } from '@wix/sdk';
import { memberFollowers } from '@wix/members';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { memberFollowers },
  // Include the auth strategy and host as relevant
});


async function listMemberFollowing(memberId, options) {
  const response = await myWixClient.memberFollowers.listMemberFollowing(memberId, options);
};

listMemberFollowing (self-hosted)

ListMemberFollowingResult

List of member IDs whose connections to the current member will be retrieved.

connectedMemberIds

Retrieves a list of members and their connections to the current member.

import { memberFollowers } from '@wix/members';

async function queryCurrentMemberConnections(connectedMemberIds) {
  const response = await memberFollowers.queryCurrentMemberConnections(connectedMemberIds);
};

queryCurrentMemberConnections

import { memberFollowers } from '@wix/members';
import { auth } from '@wix/essentials';

async function myQueryCurrentMemberConnectionsMethod(connectedMemberIds) {
  const elevatedQueryCurrentMemberConnections = auth.elevate(memberFollowers.queryCurrentMemberConnections);
  const response = await elevatedQueryCurrentMemberConnections(connectedMemberIds);
}

queryCurrentMemberConnections (with elevated permissions)

import { createClient } from '@wix/sdk';
import { memberFollowers } from '@wix/members';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { memberFollowers },
  // Include the auth strategy and host as relevant
});


async function queryCurrentMemberConnections(connectedMemberIds) {
  const response = await myWixClient.memberFollowers.queryCurrentMemberConnections(connectedMemberIds);
};

queryCurrentMemberConnections (self-hosted)

QueryMyMemberConnectionsResponse

List of member IDs whose connections to the given member will be retrieved.

Retrieves a list of members and their connections to the given member.
> **Note:** If an empty array is passed as `connectedMemberIds`, the call will succeed, but it will not return any data.

import { memberFollowers } from '@wix/members';

async function queryMemberConnections(memberId, connectedMemberIds) {
  const response = await memberFollowers.queryMemberConnections(memberId, connectedMemberIds);
};

queryMemberConnections

import { memberFollowers } from '@wix/members';
import { auth } from '@wix/essentials';

async function myQueryMemberConnectionsMethod(memberId, connectedMemberIds) {
  const elevatedQueryMemberConnections = auth.elevate(memberFollowers.queryMemberConnections);
  const response = await elevatedQueryMemberConnections(memberId, connectedMemberIds);
}

queryMemberConnections (with elevated permissions)

import { createClient } from '@wix/sdk';
import { memberFollowers } from '@wix/members';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { memberFollowers },
  // Include the auth strategy and host as relevant
});


async function queryMemberConnections(memberId, connectedMemberIds) {
  const response = await myWixClient.memberFollowers.queryMemberConnections(memberId, connectedMemberIds);
};

queryMemberConnections (self-hosted)

QueryMemberConnectionsResponse

Sets the current member to unfollow another, specified member.

import { memberFollowers } from '@wix/members';

async function unfollowMember(memberId) {
  const response = await memberFollowers.unfollowMember(memberId);
};

unfollowMember

import { createClient } from '@wix/sdk';
import { memberFollowers } from '@wix/members';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { memberFollowers },
  // Include the auth strategy and host as relevant
});


async function unfollowMember(memberId) {
  const response = await myWixClient.memberFollowers.unfollowMember(memberId);
};

unfollowMember (self-hosted)

# Introduction

The Members Follow API allows site members to follow and unfollow each other. When a site member follows another member, they receive activity notifications from the members they follow.

With the Members Followers API, you can:

- Let members [follow](https://dev.wix.com/docs/sdk/backend-modules/members/member-followers/follow-member) or [unfollow](https://dev.wix.com/docs/sdk/backend-modules/members/member-followers/unfollow-member) each other.
- List who a site member [follows](https://dev.wix.com/docs/sdk/backend-modules/members/member-followers/list-current-member-following) or is [followed](https://dev.wix.com/docs/sdk/backend-modules/members/member-followers/list-current-member-followers) by.


@package_metadata:@wix/members

To use the MemberFollowers API, install the `@wix/members` package.

#### Install the package

Follow the installation instructions for your development environment.

| Development environment | Installation method |
|--|--|
| Wix sites (editor or IDE) | Use the [package manager](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-in-the-editor). |
| Wix sites (local IDE) | Run `wix install @wix/members` using the [Wix CLI](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-with-the-wix-cli).|
| Blocks apps | Use the same installation method as Wix sites. |
| CLI and self-hosted apps | Run `npm install @wix/members` or `yarn add @wix/members`. |
| Headless sites and apps | Run `npm install @wix/members` or `yarn add @wix/members`. |

#### Import the package

To import the package in your code:

```js
import { memberFollowers } from '@wix/members'
```
  

members_member-followers

ConnectedMembers

connectedMemberId

Whether the listed member is followed by the given member.

followedByMember

boolean

Whether the listed member follows the given member.

followingMember

CursorPaging

Cursor returned from last query response.

cursor

Number of items to return. See [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).

limit

number

Cursors

Cursor string pointing to the next page in the list of results.

EventMetadata

Event ID. With this ID you can easily spot duplicated events and ignore them.

A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.

entityEventSequence

Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
For 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

eventType

The identification type and identity data.

identity

IdentificationData

instanceId

If present, indicates the action that triggered the event.

originatedFrom

Event action name, placed at the top level to make it easier for users to dispatch messages.
For 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

FollowMemberFollowedEnvelope

data

MemberFollowed

metadata

FollowMemberUnfollowedEnvelope

MemberUnfollowed

Follower

Member ID of the member being followed or unfollowed.

affectedMemberId

Member ID of the member who performed the action.

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.

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

wixUserId

identityType

WebhookIdentityType

Pagination options. For more information, see
[Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).

paging

memberIds

PagingMetadataV2

Member who is following the other member.

memberConnection

Member who is unfollowing the other member.

OnFollowMemberFollowedHandler

event

OnFollowMemberUnfollowedHandler

Number of items starting from given cursor.

count

Cursors to navigate through the result pages using `next` and `prev`.

cursors

Retrieved list of members whose connections to the given member were retrieved.

connectedMembers

Retrieved list of members whose connections to the current member were retrieved.

handler

Triggered when a member follows another member.

import { memberFollowers } from '@wix/members';

memberFollowers.onFollowMemberFollowed((event) => {
    // handle your event here
});

onFollowMemberFollowed

import { createClient, AppStrategy } from '@wix/sdk';
import { memberFollowers } from '@wix/members';

const wixClient = createClient({
  auth: AppStrategy({
    appId: 'MY-APP-ID',
    publicKey: 'YOUR_APP_PUBLIC_KEY',
  }),
  modules: {
      memberFollowers,
    },
});

wixClient.memberFollowers.onFollowMemberFollowed((event) => {
    // handle your event here
});

onFollowMemberFollowed (self-hosted)

Triggered when a member unfollows another member.

import { memberFollowers } from '@wix/members';

memberFollowers.onFollowMemberUnfollowed((event) => {
    // handle your event here
});

onFollowMemberUnfollowed

import { createClient, AppStrategy } from '@wix/sdk';
import { memberFollowers } from '@wix/members';

const wixClient = createClient({
  auth: AppStrategy({
    appId: 'MY-APP-ID',
    publicKey: 'YOUR_APP_PUBLIC_KEY',
  }),
  modules: {
      memberFollowers,
    },
});

wixClient.memberFollowers.onFollowMemberUnfollowed((event) => {
    // handle your event here
});

onFollowMemberUnfollowed( )