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

# Namespace: schedulesV3

# Webhook link: https://dev.wix.com/docs/api-reference/business-management/calendar/schedules-v3/schedule-updated.md

## Introduction

Triggered when a schedule is updated.

---

## REST API

### Schema

```
Webhook: Schedule Updated
Description: Triggered when a schedule 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: Schedule | description: The entity after the update.
        - name: id | type: string | description: Schedule GUID.
        - name: externalId | type: string | description: External GUID. You can't update the external GUID.  If the schedule belongs to a Bookings staff member, identical to the GUID of the [resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object.md). If the schedule belongs to a Bookings service, identical to the GUID of the [service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object.md).
        - name: name | type: string | description: Schedule name.  Min: 1 character Max: 200 characters
        - name: status | type: Status | description: Schedule status.  Supported values: - `ACTIVE`: You can add events to the schedule or update its fields. - `CANCELLED`: You can't add events to the schedule or update its fields.  Default: `ACTIVE`
           - enum:
           -     UNKNOWN_STATUS: 
           -     ACTIVE: You can add events to the schedule or update its fields.
           -     CANCELLED: You can't add events to the schedule or update its fields.
        - name: timeZone | type: string | description: Time zone the schedule is associated with in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database). For example, `America/New_York`.  Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties.md).  Min: 1 character Max: 150 characters
        - name: businessTimeZoneEnabled | type: boolean | description: Whether the schedule's `timeZone` is automatically synced from `timeZone` of the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties.md).  Default: `true`
        - name: defaultTitle | type: string | description: Default `title` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object.md) that are added to the schedule.  Min: 1 character Max: 200 characters
        - name: defaultLocation | type: Location | description: Default `location` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object.md) that are added to the schedule.
           - name: id | type: string | description: [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object.md) GUID. Available only for `BUSINESS` locations.
           - name: type | type: Type | description: Location type.  Supported values: + `BUSINESS`: The event is held at a business location. + `CUSTOMER`: The event is held at the customer's location, such as their home or office. + `CUSTOM`: The event is held at an address or venue not tied to the business or customer.
               - enum:
               -     BUSINESS: The event is held at a business location.
               -     CUSTOMER: The event is held at the customer's location, such as their home or office.
               -     CUSTOM: The event is held at an address or venue not tied to the business or customer.
           - name: name | type: string | description: Location name. For `BUSINESS` locations, it's identical to the [location](https://dev.wix.com/docs/rest/business-management/locations/location-object.md) `name`.  Min: 1 character Max: 150 characters
           - name: address | type: string | description: Location address. For `BUSINESS` locations, it's identical to the [location](https://dev.wix.com/docs/rest/business-management/locations/location-object.md)'s `formattedAddress`.
        - name: defaultCapacity | type: integer | description: Default `totalCapacity` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object.md) that are added to the schedule.  Min: `0`
        - name: defaultConferencingDetails | type: ConferencingDetails | description: Default `conferencingDetails` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object.md) that are added to the schedule. Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions.md#retrieve-personal-information).
           - name: type | type: Type | description: Conference type. For example, `Zoom`.
               - enum: UNKNOWN_TYPE, ZOOM, CUSTOM
           - name: hostUrl | type: string | description: URL used by the host to start the conference.  Min: 1 character Max: 2000 characters
           - name: guestUrl | type: string | description: URL used by a guest to join the conference.  Min: 1 character Max: 2000 characters
           - name: password | type: string | description: Conference password.  Min: 1 character Max: 100 characters
           - name: externalId | type: string | description: Conference GUID in an external system.  Min: 1 character Max: 150 characters
        - name: appId | type: string | description: GUID of the app that's associated with the schedule. You can't update `appId`. If you want to create a schedule and ensure its associated events appear in the [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar), you must provide the Wix Bookings app GUID `13d21c63-b5ec-5912-8397-c3a5ddb27a97`. For schedules from Wix apps, the following values apply: - Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"` - Wix Services: `"cc552162-24a4-45e0-9695-230c4931ef40"` - Wix Meetings: `"6646a75c-2027-4f49-976c-58f3d713ed0f"` [Full list of apps created by Wix](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/platform/about-apps-created-by-wix.md).
        - name: permissions | type: array<Permission> | description: List of permissions associated with the schedule. Refer to the [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions.md#roles) for more information.  Max: 1 permission
           - name: identity | type: IdentificationData | description: [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities.md#wix-users) granted the permission.
              - ONE-OF:
                 - name: wixUserId | type: string | description: GUID of a Wix user. For example, the site owner or a [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
           - name: role | type: Role | description: Permission role.  Supported values: + `WRITER`: Full read and write access. + `COMMENTER`: Full read access, write access limited to `event.notes`.
               - enum:
               -     WRITER: Full read and write access.
               -     COMMENTER: Full read access, write access limited to `event.notes`.
        - name: extendedFields | type: ExtendedFields | description: Extensions enabling applications or users to save custom data related to the schedule.
           - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md).
        - name: revision | type: string | description: Revision number, which increments by 1 each time the schedule is updated. To prevent conflicting changes, the current revision must be passed when updating the schedule. Ignored when creating a schedule.
        - name: createdDate | type: string | description: Date the schedule was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
        - name: updatedDate | type: string | description: Date the schedule was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.

```

### Examples


```curl
{
  "id": "2649639b-7eb8-437d-804d-cb672efbed07",
  "entityFqdn": "wix.calendar.v3.schedule",
  "slug": "updated",
  "entityId": "132db383-1378-4903-820b-4eebf4242de2",
  "updatedEvent": {
    "currentEntity": {
      "id": "132db383-1378-4903-820b-4eebf4242de2",
      "externalId": "4187d1f3-38a2-4cfd-b8f1-6333cd012e33",
      "name": "Hip Hop Groove",
      "status": "ACTIVE",
      "timeZone": "Europe/Dublin",
      "businessTimeZoneEnabled": true,
      "defaultTitle": "Hip Hop Groove",
      "defaultLocation": {
        "type": "BUSINESS"
      },
      "defaultCapacity": 40,
      "appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97",
      "permissions": [],
      "revision": "2",
      "createdDate": "2024-10-06T17:16:35.344Z",
      "updatedDate": "2024-10-14T08:24:15.788Z"
    }
  },
  "eventTime": "2024-10-14T08:24:15.794401237Z",
  "triggeredByAnonymizeRequest": false,
  "entityEventSequence": "2"
}
```

---

## JavaScript SDK

### Schema

```
Webhook: onScheduleUpdated
Description: Triggered when a schedule is updated.
Payload: ScheduleUpdatedEnvelope
  - name: entity | type: Schedule | description: none
     - name: _id | type: string | description: Schedule GUID.
     - name: externalId | type: string | description: External GUID. You can't update the external GUID.  If the schedule belongs to a Bookings staff member, identical to the GUID of the [resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object.md). If the schedule belongs to a Bookings service, identical to the GUID of the [service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object.md).
     - name: name | type: string | description: Schedule name.  Min: 1 character Max: 200 characters
     - name: status | type: Status | description: Schedule status.  Supported values: - `ACTIVE`: You can add events to the schedule or update its fields. - `CANCELLED`: You can't add events to the schedule or update its fields.  Default: `ACTIVE`
         - enum:
         -     UNKNOWN_STATUS: 
         -     ACTIVE: You can add events to the schedule or update its fields.
         -     CANCELLED: You can't add events to the schedule or update its fields.
     - name: timeZone | type: string | description: Time zone the schedule is associated with in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database). For example, `America/New_York`.  Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties.md).  Min: 1 character Max: 150 characters
     - name: businessTimeZoneEnabled | type: boolean | description: Whether the schedule's `timeZone` is automatically synced from `timeZone` of the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties.md).  Default: `true`
     - name: defaultTitle | type: string | description: Default `title` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object.md) that are added to the schedule.  Min: 1 character Max: 200 characters
     - name: defaultLocation | type: Location | description: Default `location` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object.md) that are added to the schedule.
        - name: _id | type: string | description: [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object.md) GUID. Available only for `BUSINESS` locations.
        - name: type | type: Type | description: Location type.  Supported values: + `BUSINESS`: The event is held at a business location. + `CUSTOMER`: The event is held at the customer's location, such as their home or office. + `CUSTOM`: The event is held at an address or venue not tied to the business or customer.
             - enum:
             -     BUSINESS: The event is held at a business location.
             -     CUSTOMER: The event is held at the customer's location, such as their home or office.
             -     CUSTOM: The event is held at an address or venue not tied to the business or customer.
        - name: name | type: string | description: Location name. For `BUSINESS` locations, it's identical to the [location](https://dev.wix.com/docs/rest/business-management/locations/location-object.md) `name`.  Min: 1 character Max: 150 characters
        - name: address | type: string | description: Location address. For `BUSINESS` locations, it's identical to the [location](https://dev.wix.com/docs/rest/business-management/locations/location-object.md)'s `formattedAddress`.
     - name: defaultCapacity | type: integer | description: Default `totalCapacity` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object.md) that are added to the schedule.  Min: `0`
     - name: defaultConferencingDetails | type: ConferencingDetails | description: Default `conferencingDetails` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object.md) that are added to the schedule. Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions.md#retrieve-personal-information).
        - name: type | type: Type | description: Conference type. For example, `Zoom`.
             - enum: UNKNOWN_TYPE, ZOOM, CUSTOM
        - name: hostUrl | type: string | description: URL used by the host to start the conference.  Min: 1 character Max: 2000 characters
        - name: guestUrl | type: string | description: URL used by a guest to join the conference.  Min: 1 character Max: 2000 characters
        - name: password | type: string | description: Conference password.  Min: 1 character Max: 100 characters
        - name: externalId | type: string | description: Conference GUID in an external system.  Min: 1 character Max: 150 characters
     - name: appId | type: string | description: GUID of the app that's associated with the schedule. You can't update `appId`. If you want to create a schedule and ensure its associated events appear in the [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar), you must provide the Wix Bookings app GUID `13d21c63-b5ec-5912-8397-c3a5ddb27a97`. For schedules from Wix apps, the following values apply: - Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"` - Wix Services: `"cc552162-24a4-45e0-9695-230c4931ef40"` - Wix Meetings: `"6646a75c-2027-4f49-976c-58f3d713ed0f"` [Full list of apps created by Wix](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/platform/about-apps-created-by-wix.md).
     - name: permissions | type: array<Permission> | description: List of permissions associated with the schedule. Refer to the [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions.md#roles) for more information.  Max: 1 permission
        - name: identity | type: IdentificationData | description: [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities.md#wix-users) granted the permission.
           - ONE-OF:
              - name: wixUserId | type: string | description: GUID of a Wix user. For example, the site owner or a [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
        - name: role | type: Role | description: Permission role.  Supported values: + `WRITER`: Full read and write access. + `COMMENTER`: Full read access, write access limited to `event.notes`.
             - enum:
             -     WRITER: Full read and write access.
             -     COMMENTER: Full read access, write access limited to `event.notes`.
     - name: extendedFields | type: ExtendedFields | description: Extensions enabling applications or users to save custom data related to the schedule.
        - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md).
     - name: revision | type: string | description: Revision number, which increments by 1 each time the schedule is updated. To prevent conflicting changes, the current revision must be passed when updating the schedule. Ignored when creating a schedule.
     - name: _createdDate | type: Date | description: Date the schedule was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
     - name: _updatedDate | type: Date | description: Date the schedule was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
  - 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 { schedules } from '@wix/calendar';

schedules.onScheduleUpdated((event) => {
    // handle your event here
});
```


```javascript
import { createClient, AppStrategy } from '@wix/sdk';
import { schedules } from '@wix/calendar';

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

wixClient.schedules.onScheduleUpdated((event) => {
    // handle your event here
});
```

---