> 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: staffMembers # Namespace: staffMemberSettings # Webhook link: https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/staff-member-settings/staff-member-settings-updated.md ## Introduction Triggered when a `staffMemberSettings` object is updated. --- ## REST API ### Schema ``` Webhook: Staff Member Settings Updated Description: Triggered when a `staffMemberSettings` object 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: StaffMemberSettings | description: The entity after the update. - name: id | type: string | description: GUID of the staff member settings object. There is one settings object per site. - name: revision | type: string | description: Revision number, which increments by 1 each time the `staffMemberSettings` object is updated. To prevent conflicting changes, the current revision must be specified when updating the `staffMemberSettings` object. - name: createdDate | type: string | description: Date and time the `staffMemberSettings` object was created in `YYYY-MM-DDThh:mm:ss.sssZ` format. - name: updatedDate | type: string | description: Date and time the `staffMemberSettings` object was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format. - name: contactInformation | type: ContactInformation | description: Privacy settings for controlling staff member contact information visibility in API responses and on the live site. - name: publiclyAccessible | type: boolean | description: Whether staff members' email addresses and phone numbers are accessible in API responses and on the live site. - `true`: The `email` and `phone` fields in [staff member objects](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/staff-members/staff-member-object.md) contain actual contact information, and this information is displayed on the live site. - `false`: These fields are empty in API responses if the calling [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities.md) doesn't have sufficient permissions, and contact information isn't displayed on the live site. Identities with appropriate permissions can still access this information in API responses regardless of this setting. Default: `false` - name: extendedFields | type: ExtendedFields | description: Custom field data for the staff member settings. Extended fields must be configured in the app dashboard before they can be accessed with API calls. Learn more about extended fields at https://dev.wix.com/docs/rest/articles/getting-started/extended-fields..md - 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: modifiedFields | type: Map | description: Fields that were updated and their values before the update. ``` ### Examples ```curl { "id": "7c2f5a8d-3e9b-4f1c-8d6a-9b3e7f2c5a1d", "entityFqdn": "wix.bookings.staff_settings.v1.staff_member_settings", "slug": "updated", "entityId": "e7b3c9f2-4a5d-4e8c-9b2f-1a6c8d3e5f7b", "eventTime": "2024-03-21T16:45:00.000Z", "triggeredByAnonymizeRequest": false, "action": "UPDATED", "entityEventSequence": "4", "updatedEvent": { "currentEntityAsJson": "{\"id\":\"e7b3c9f2-4a5d-4e8c-9b2f-1a6c8d3e5f7b\",\"revision\":\"4\",\"createdDate\":\"2024-01-15T09:30:00.000Z\",\"updatedDate\":\"2024-03-21T16:45:00.000Z\",\"contactInformation\":{\"publiclyAccessible\":true}}", "entity": { "id": "e7b3c9f2-4a5d-4e8c-9b2f-1a6c8d3e5f7b", "revision": "4", "createdDate": "2024-01-15T09:30:00.000Z", "updatedDate": "2024-03-21T16:45:00.000Z", "contactInformation": { "publiclyAccessible": true } }, "modifiedFields": [ { "fieldName": "contactInformation.publiclyAccessible", "oldValue": "false", "newValue": "true" }, { "fieldName": "revision", "oldValue": "3", "newValue": "4" }, { "fieldName": "updatedDate", "oldValue": "2024-02-20T14:22:00.000Z", "newValue": "2024-03-21T16:45:00.000Z" } ] } } ``` --- ## JavaScript SDK ### Schema ``` Webhook: onStaffMemberSettingsUpdated Description: Triggered when a `staffMemberSettings` object is updated. Payload: StaffMemberSettingsUpdatedEnvelope - name: entity | type: StaffMemberSettings | description: none - name: _id | type: string | description: GUID of the staff member settings object. There is one settings object per site. - name: revision | type: string | description: Revision number, which increments by 1 each time the `staffMemberSettings` object is updated. To prevent conflicting changes, the current revision must be specified when updating the `staffMemberSettings` object. - name: _createdDate | type: Date | description: Date and time the `staffMemberSettings` object was created in `YYYY-MM-DDThh:mm:ss.sssZ` format. - name: _updatedDate | type: Date | description: Date and time the `staffMemberSettings` object was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format. - name: contactInformation | type: ContactInformation | description: Privacy settings for controlling staff member contact information visibility in API responses and on the live site. - name: publiclyAccessible | type: boolean | description: Whether staff members' email addresses and phone numbers are accessible in API responses and on the live site. - `true`: The `email` and `phone` fields in [staff member objects](https://dev.wix.com/docs/api-reference/business-solutions/bookings/staff-members/staff-members/staff-member-object.md) contain actual contact information, and this information is displayed on the live site. - `false`: These fields are empty in API responses if the calling [identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities.md) doesn't have sufficient permissions, and contact information isn't displayed on the live site. Identities with appropriate permissions can still access this information in API responses regardless of this setting. Default: `false` - name: extendedFields | type: ExtendedFields | description: Custom field data for the staff member settings. Extended fields must be configured in the app dashboard before they can be accessed with API calls. Learn more about extended fields at https://dev.wix.com/docs/rest/articles/getting-started/extended-fields..md - 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: modifiedFields | type: Map | description: Fields that were updated and their values before the update. - ONE-OF: - name: nullValue | type: | description: - name: numberValue | type: number | description: - name: stringValue | type: string | description: - name: boolValue | type: boolean | description: - name: structValue | type: object | description: - name: listValue | type: ListValue | description: - name: values | type: array | description: - 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 { staffMemberSettings } from '@wix/bookings'; staffMemberSettings.onStaffMemberSettingsUpdated((event) => { // handle your event here }); ``` ```javascript import { createClient, AppStrategy } from '@wix/sdk'; import { staffMemberSettings } from '@wix/bookings'; const wixClient = createClient({ auth: AppStrategy({ appId: 'MY-APP-ID', publicKey: 'YOUR_APP_PUBLIC_KEY', }), modules: { staffMemberSettings, }, }); wixClient.staffMemberSettings.onStaffMemberSettingsUpdated((event) => { // handle your event here }); ``` ---