> 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: blog # Namespace: blogSettings # Webhook link: https://dev.wix.com/docs/api-reference/business-solutions/blog/blog-settings/blog-settings-updated.md # Webhook Permissions Scopes IDs: Read Blog : SCOPE.DC-BLOG.READ-BLOGS ## Introduction Triggered when blog settings are updated. --- ## REST API ### Schema ``` Webhook: Blog Settings Updated Description: Triggered when blog settings are 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: BlogSettings | description: The entity after the update. - name: revision | type: string | description: Revision number, which increments by 1 each time the blog settings are updated. To prevent conflicting changes, the current revision must be passed when updating the blog settings. - name: allPostsFeedLabel | type: string | description: Label of the feed that lists all posts. Translatable. Specify `language` on Get Blog Settings or Update Blog Settings to read or write this label in a specific language. Default: `All posts` when the site has no saved blog settings. - name: comments | type: Comments | description: Comment settings for the blog. When updating comments, include `enabled`, `anonymousEnabled`, `ratingsEnabled`, and `ratingsMandatory` together. A partial comments object is rejected. - name: enabled | type: boolean | description: Whether comments are turned on for the blog. Default: `true` when the site has no saved blog settings. - name: anonymousEnabled | type: boolean | description: Whether visitors can comment without signing in. Default: `false` when the site has no saved blog settings. - name: ratingsEnabled | type: boolean | description: Whether visitors can rate a post when they comment. Default: `false` when the site has no saved blog settings. - name: ratingsMandatory | type: boolean | description: Whether a rating is required when a visitor leaves a comment. Default: `false` when the site has no saved blog settings. - name: modifiedFields | type: Map | description: Fields that were updated and their values before the update. ``` --- ## JavaScript SDK ### Schema ``` Webhook: onBlogSettingsUpdated Description: Triggered when blog settings are updated. Payload: BlogSettingsUpdatedEnvelope - name: entity | type: BlogSettings | description: none - name: revision | type: string | description: Revision number, which increments by 1 each time the blog settings are updated. To prevent conflicting changes, the current revision must be passed when updating the blog settings. - name: allPostsFeedLabel | type: string | description: Label of the feed that lists all posts. Translatable. Specify `language` on Get Blog Settings or Update Blog Settings to read or write this label in a specific language. Default: `All posts` when the site has no saved blog settings. - name: comments | type: Comments | description: Comment settings for the blog. When updating comments, include `enabled`, `anonymousEnabled`, `ratingsEnabled`, and `ratingsMandatory` together. A partial comments object is rejected. - name: enabled | type: boolean | description: Whether comments are turned on for the blog. Default: `true` when the site has no saved blog settings. - name: anonymousEnabled | type: boolean | description: Whether visitors can comment without signing in. Default: `false` when the site has no saved blog settings. - name: ratingsEnabled | type: boolean | description: Whether visitors can rate a post when they comment. Default: `false` when the site has no saved blog settings. - name: ratingsMandatory | type: boolean | description: Whether a rating is required when a visitor leaves a comment. Default: `false` when the site has no saved blog settings. - 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 { blogSettings } from '@wix/blog'; blogSettings.onBlogSettingsUpdated((event) => { // handle your event here }); ``` ```javascript import { createClient, AppStrategy } from '@wix/sdk'; import { blogSettings } from '@wix/blog'; const wixClient = createClient({ auth: AppStrategy({ appId: 'MY-APP-ID', publicKey: 'YOUR_APP_PUBLIC_KEY', }), modules: { blogSettings, }, }); wixClient.blogSettings.onBlogSettingsUpdated((event) => { // handle your event here }); ``` ---