> 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 # GetReferralEvent # Package: referralProgram # Namespace: ReferralEvents # Method link: https://dev.wix.com/docs/api-reference/business-management/marketing/referral-program/referral-tracker/get-referral-event.md ## Permission Scopes: Manage Referrals: SCOPE.DC-REFERRALS.MANAGE-REFERRALS ## Introduction Retrieves a referral event by ID. --- ## REST API ### Schema ``` Method: getReferralEvent Description: Retrieves a referral event by GUID. URL: https://www.wixapis.com/v1/referral-events/{referralEventId} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: referralEventId Method parameters: param name: referralEventId | type: none | required: true Return type: GetReferralEventResponse - name: referralEvent | type: ReferralEvent | description: Retrieved referral event. - ONE-OF: - name: referredFriendSignupEvent | type: ReferredFriendSignupEvent | description: Event triggered when a referred friend signs up. - name: referredFriendId | type: string | description: GUID of the referred friend. - name: successfulReferralEvent | type: SuccessfulReferralEvent | description: Event triggered when a referral is successful. For example, customer places and pays for an order. - name: referredFriendId | type: string | description: GUID of the referred friend. - name: referringCustomerId | type: string | description: GUID of the referring customer. - name: actionEvent | type: ActionEvent | description: Event triggered when an action is performed. For example, placing an order. - name: referredFriendId | type: string | description: GUID of the referred friend. - name: referringCustomerId | type: string | description: GUID of the referring customer. - name: trigger | type: Trigger | description: Trigger for the action. - name: appId | type: string | description: GUID of the app that triggered the event. - name: activityType | type: string | description: Type of activity that triggered the event. - name: amount | type: string | description: Amount associated with the action. - name: currency | type: string | description: Currency of the amount. - name: orderId | type: string | description: GUID of the associated order. - name: rewardEvent | type: RewardEvent | description: Event triggered when a reward is given. - name: referralRewardId | type: string | description: GUID of the referral reward. - name: rewardType | type: Reward | description: Type of reward. - enum: - UNKNOWN: Unknown reward. This field is not used. - COUPON: Reward is a coupon. - LOYALTY_POINTS: Reward is loyalty points. - NOTHING: No reward. - name: id | type: string | description: Referral event GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the referral event is updated. To prevent conflicting changes, the current revision must be passed when updating the referral event. - name: createdDate | type: string | description: Date and time the referral event was created. - name: updatedDate | type: string | description: Date and time the referral event was last updated. ``` ### Examples ### Get Referral Event ```curl curl -X GET \ 'https://www.wixapis.com/_api/referral-tracker/v1/referral-events/017fad99-aa0f-47a9-8d4f-177fc6a07da3' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.referralProgram.ReferralEvents.getReferralEvent(referralEventId) Description: Retrieves a referral event by GUID. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: referralEventId Method parameters: param name: referralEventId | type: string | description: GUID of the referral event to retrieve. | required: true Return type: PROMISE - ONE-OF: - name: referredFriendSignupEvent | type: ReferredFriendSignupEvent | description: Event triggered when a referred friend signs up. - name: referredFriendId | type: string | description: GUID of the referred friend. - name: successfulReferralEvent | type: SuccessfulReferralEvent | description: Event triggered when a referral is successful. For example, customer places and pays for an order. - name: referredFriendId | type: string | description: GUID of the referred friend. - name: referringCustomerId | type: string | description: GUID of the referring customer. - name: actionEvent | type: ActionEvent | description: Event triggered when an action is performed. For example, placing an order. - name: referredFriendId | type: string | description: GUID of the referred friend. - name: referringCustomerId | type: string | description: GUID of the referring customer. - name: trigger | type: Trigger | description: Trigger for the action. - name: appId | type: string | description: GUID of the app that triggered the event. - name: activityType | type: string | description: Type of activity that triggered the event. - name: amount | type: string | description: Amount associated with the action. - name: currency | type: string | description: Currency of the amount. - name: orderId | type: string | description: GUID of the associated order. - name: rewardEvent | type: RewardEvent | description: Event triggered when a reward is given. - name: referralRewardId | type: string | description: GUID of the referral reward. - name: rewardType | type: Reward | description: Type of reward. - enum: - UNKNOWN: Unknown reward. This field is not used. - COUPON: Reward is a coupon. - LOYALTY_POINTS: Reward is loyalty points. - NOTHING: No reward. - name: _id | type: string | description: Referral event GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the referral event is updated. To prevent conflicting changes, the current revision must be passed when updating the referral event. - name: _createdDate | type: Date | description: Date and time the referral event was created. - name: _updatedDate | type: Date | description: Date and time the referral event was last updated. ``` ### Examples ### getReferralEvent ```javascript import { tracker } from '@wix/referral'; async function getReferralEvent(referralEventId) { const response = await tracker.getReferralEvent(referralEventId); }; ``` ### getReferralEvent (with elevated permissions) ```javascript import { tracker } from '@wix/referral'; import { auth } from '@wix/essentials'; async function myGetReferralEventMethod(referralEventId) { const elevatedGetReferralEvent = auth.elevate(tracker.getReferralEvent); const response = await elevatedGetReferralEvent(referralEventId); } ``` ### getReferralEvent (self-hosted) 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.md). ```javascript import { createClient } from '@wix/sdk'; import { tracker } from '@wix/referral'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { tracker }, // Include the auth strategy and host as relevant }); async function getReferralEvent(referralEventId) { const response = await myWixClient.tracker.getReferralEvent(referralEventId); }; ``` ---