> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# Package: referralProgram

# Namespace: referredFriends

# Webhook link: https://dev.wix.com/docs/api-reference/business-management/marketing/referral-program/referred-friends/referred-friend-created.md

## Introduction

Triggered when a referred friend is created.

---

## REST API

### Schema

```
Webhook: Referred Friend Created
Description: Triggered when a referred friend is created.
Event body:
 - name: id | type: string | description: Unique event ID. Allows clients to ignore duplicate events.
 - name: entityFqdn | type: string | description: Fully qualified domain name of the entity associated with the event.
 - name: slug | type: string | description: Event name.
 - name: entityId | type: string | description: ID of the entity associated with the event.
 - name: eventTime | type: string (date-time) | description: Event timestamp.
 - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application such as GDPR.
 - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event.
 - name: createdEvent | type: object | description: Created event details.
    - name: entity | type: ReferredFriend | description: The created entity.
        - name: id | type: string | description: GUID of the referred friend.
        - name: contactId | type: string | description: Contact GUID of the referred friend.
        - name: referringCustomerId | type: string | description: GUID of the customer who referred this friend.
        - name: status | type: Status | description: Status of the referred friend.
           - enum:
           -     UNKNOWN: Unknown status.
           -     SIGN_UP_COMPLETED: Initial status when the referred friend joins the site as a member.
           -     ACTIONS_COMPLETED: Status after the referred friend completes a specific action, such as making a purchase.
        - name: revision | type: string | description: Revision number, which increments by 1 each time the referred friend is updated. To prevent conflicting changes, the current revision must be passed when updating the referred friend.
        - name: createdDate | type: string | description: Date and time the referred friend was created.
        - name: updatedDate | type: string | description: Date and time the referred friend was last updated.

```

### Examples


```curl
{
  "id": "9aca3895-8c58-48b7-84a5-35bcd431c125",
  "entityFqdn": "wix.loyalty.referral.v1.referred_friend",
  "slug": "created",
  "entityId": "aaf51c30-a61c-473e-96be-a42dfa5064c0",
  "eventTime": "2024-08-12T08:12:17.813Z",
  "createdEvent": {
    "entity": {
      "id": "3857d039-b129-4393-b983-947078b6a007",
      "contactId": "661f5bb3-0723-4aa4-87d7-a21ebd1d0fa3",
      "referringCustomerId": "07a3306c-b311-466e-92dd-c635c4145d1c",
      "status": "ACTIONS_COMPLETED",
      "revision": "2",
      "createdDate": "2024-08-12T08:12:17.813Z",
      "updatedDate": "2024-08-12T08:13:27.708Z"
    }
  }
}
```

---

## JavaScript SDK

### Schema

```
Webhook: onReferredFriendCreated
Description: Triggered when a referred friend is created.
Payload: ReferredFriendCreatedEnvelope
  - name: entity | type: ReferredFriend | description: none
     - name: _id | type: string | description: GUID of the referred friend.
     - name: contactId | type: string | description: Contact GUID of the referred friend.
     - name: referringCustomerId | type: string | description: GUID of the customer who referred this friend.
     - name: status | type: Status | description: Status of the referred friend.
         - enum:
         -     UNKNOWN: Unknown status.
         -     SIGN_UP_COMPLETED: Initial status when the referred friend joins the site as a member.
         -     ACTIONS_COMPLETED: Status after the referred friend completes a specific action, such as making a purchase.
     - name: revision | type: string | description: Revision number, which increments by 1 each time the referred friend is updated. To prevent conflicting changes, the current revision must be passed when updating the referred friend.
     - name: _createdDate | type: Date | description: Date and time the referred friend was created.
     - name: _updatedDate | type: Date | description: Date and time the referred friend was last updated.
  - name: metadata | type: EventMetadata | description: none
     - name: instanceId | type: string | description: App instance GUID.
     - name: eventType | type: string | description: Event type.
     - name: identity | type: IdentificationData | description: The identification type and identity data.
        - ONE-OF:
           - name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site.
           - name: memberId | type: string | description: GUID of a site visitor that has logged in to the site.
           - name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.).
           - name: appId | type: string | description: GUID of an app.
        - name: identityType | type: WebhookIdentityType | description: 
             - enum: UNKNOWN, ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
     - name: accountInfo | type: AccountInfo | description: Details related to the account
        - name: accountId | type: string | description: GUID of the Wix account associated with the event.
        - name: parentAccountId | type: string | description: GUID of the parent Wix account. Only included when accountId belongs to a child account.
        - name: siteId | type: string | description: GUID of the Wix site associated with the event. Only included when the event is tied to a specific site.
     - name: _id | type: string | description: Event GUID. With this GUID you can easily spot duplicated events and ignore them.
     - name: entityFqdn | type: string | description: 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`.
     - name: slug | type: string | description: 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`.
     - name: entityId | type: string | description: GUID of the entity associated with the event.
     - name: eventTime | type: Date | description: Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`.
     - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
     - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event.
     - name: entityEventSequence | type: string | description: 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.

```

### Examples


```javascript
import { friends } from '@wix/referral';

friends.onReferredFriendCreated((event) => {
    // handle your event here
});
```


```javascript
import { createClient, AppStrategy } from '@wix/sdk';
import { friends } from '@wix/referral';

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

wixClient.friends.onReferredFriendCreated((event) => {
    // handle your event here
});
```

---