> 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: loyaltyProgramManagement

# Namespace: program

# Webhook link: https://dev.wix.com/docs/api-reference/crm/loyalty-program/loyalty-program-management/program/loyalty-program-updated.md

## Introduction

Triggered when a loyalty program is updated.

---

## REST API

### Schema

```
Webhook: Loyalty Program Updated
Description: Triggered when a loyalty program is updated.
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: updatedEvent | type: object | description: Updated event details.
    - name: currentEntity | type: LoyaltyProgram | description: The entity after the update.
        - name: name | type: string | description: Program name.
        - name: pointDefinition | type: PointDefinition | description: Details about the program's collectible unit.
           - name: customName | type: string | description: Display name for the program's collectible unit.  It's recommended to use a plural, for example `"Stars"`.  In contrast to a custom name, the default `"Points"` name is translated and adjusted to singular based on circumstances.  Default: `"Points"`.
           - name: icon | type: Image | description: Details about the points icon.
              - name: id | type: string | description: WixMedia image GUID.
              - name: url | type: string | description: Image URL.
              - name: height | type: integer | description: Original image height.
              - name: width | type: integer | description: Original image width.
              - name: altText | type: string | description: Image alt text.
              - name: filename | type: string | description: Image filename.
        - name: status | type: ProgramStatus | description: Program status. Customers can only earn or redeem points while the program is `"ACTIVE"`.  Default: `"DRAFT"`
           - enum:
           -     UNKNOWN: Unknown program status.
           -     DRAFT: Program is in draft mode. Customers can't earn or redeem points.
           -     ACTIVE: Program is active. Customers can earn and redeem points.
           -     PAUSED: Program is paused. Customers can't earn or redeem points while the program is paused.  Set the program to `"ACTIVE"` to resume earning and redeeming points.
        - name: createdDate | type: string | description: Date and time the program was created.
        - name: updatedDate | type: string | description: Date and time the program was updated.
        - name: pointsExpiration | type: PointsExpiration | description: Configuration for the points expiration feature.
           - name: status | type: Status | description: Status of the points expiration feature.
               - enum:
               -     DISABLED: Points expiration feature is disabled.
               -     ENABLED: Points expiration feature is enabled.
           - name: monthsOfInactivity | type: integer | description: How many months a member should be inactive to lose the collected points.
           - name: expiringPointsPercentage | type: integer | description: Percentage of points that a member loses after being inactive.
        - name: premiumFeatures | type: PremiumFeatures | description: Information about the available program premium features.
           - name: loyaltyProgram | type: boolean | description: Whether there are any loyalty program premium features.
           - name: tiers | type: boolean | description: Whether this loyalty program includes tiers.
           - name: pointsExpiration | type: boolean | description: Whether this loyalty program includes point expiration.

```

---

## JavaScript SDK

### Schema

```
Webhook: onProgramUpdated
Description: Triggered when a loyalty program is updated.
Payload: ProgramUpdatedEnvelope
  - name: entity | type: LoyaltyProgram | description: none
     - name: name | type: string | description: Program name.
     - name: pointDefinition | type: PointDefinition | description: Details about the program's collectible unit.
        - name: customName | type: string | description: Display name for the program's collectible unit.  It's recommended to use a plural, for example `"Stars"`.  In contrast to a custom name, the default `"Points"` name is translated and adjusted to singular based on circumstances.  Default: `"Points"`.
        - name: icon | type: string | description: Details about the points icon.
     - name: status | type: ProgramStatus | description: Program status. Customers can only earn or redeem points while the program is `"ACTIVE"`.  Default: `"DRAFT"`
         - enum:
         -     UNKNOWN: Unknown program status.
         -     DRAFT: Program is in draft mode. Customers can't earn or redeem points.
         -     ACTIVE: Program is active. Customers can earn and redeem points.
         -     PAUSED: Program is paused. Customers can't earn or redeem points while the program is paused.  Set the program to `"ACTIVE"` to resume earning and redeeming points.
     - name: _createdDate | type: Date | description: Date and time the program was created.
     - name: _updatedDate | type: Date | description: Date and time the program was updated.
     - name: pointsExpiration | type: PointsExpiration | description: Configuration for the points expiration feature.
        - name: status | type: Status | description: Status of the points expiration feature.
             - enum:
             -     DISABLED: Points expiration feature is disabled.
             -     ENABLED: Points expiration feature is enabled.
        - name: monthsOfInactivity | type: integer | description: How many months a member should be inactive to lose the collected points.
        - name: expiringPointsPercentage | type: integer | description: Percentage of points that a member loses after being inactive.
     - name: premiumFeatures | type: PremiumFeatures | description: Information about the available program premium features.
        - name: loyaltyProgram | type: boolean | description: Whether there are any loyalty program premium features.
        - name: tiers | type: boolean | description: Whether this loyalty program includes tiers.
        - name: pointsExpiration | type: boolean | description: Whether this loyalty program includes point expiration.
  - 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 { programs } from '@wix/loyalty';

programs.onProgramUpdated((event) => {
    // handle your event here
});
```


```javascript
import { createClient, AppStrategy } from '@wix/sdk';
import { programs } from '@wix/loyalty';

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

wixClient.programs.onProgramUpdated((event) => {
    // handle your event here
});
```

---