> 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: onlinePrograms # Namespace: steps # Webhook link: https://dev.wix.com/docs/api-reference/business-management/online-programs/steps/step-updated.md # Webhook Permissions Scopes IDs: Manage Online Programs: SCOPE.CHALLENGES.MANAGE ## Introduction Triggered when a step is updated. --- ## REST API ### Schema ``` Webhook: Step Updated Description: Triggered when a step 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: Step | description: The entity after the update. - ONE-OF: - name: videoOptions | type: VideoOptions | description: Video-specific settings. - ONE-OF: - name: wixVideo | type: WixVideo | description: Video from Wix Video. - name: id | type: string | description: Wix Video GUID. - name: paid | type: boolean | description: Whether the Wix Video is paid content. - name: video | type: VideoV2 | description: Video uploaded with Media Manager. - name: id | type: string | description: WixMedia GUID. - name: resolutions | type: array | description: Available resolutions for the video, starting with the optimal resolution. - name: url | type: string | description: Video URL. - name: height | type: integer | description: Video height. - name: width | type: integer | description: Video width. - name: format | type: string | description: Video format for example, mp4, hls. - name: filename | type: string | description: Video filename. - name: requiredCompletionPercentage | type: number | description: Percentage of the video that must be watched to complete the step. - name: coverImage | type: Image | description: Cover image for the video. - 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: durationInMilliseconds | type: integer | description: Video duration in milliseconds. - name: deleted | type: boolean | description: Whether the uploaded video was deleted from Media Manager. - name: quizOptions | type: QuizOptions | description: Quiz-specific settings. - name: id | type: string | description: Quiz GUID. Provide it when creating a quiz step. After creation, the quiz reference can't be changed. - name: totalQuestions | type: integer | description: Total number of questions in the quiz. - name: passingGrade | type: number | description: Minimum percentage required to pass the quiz. - name: id | type: string | description: Step GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the step is updated. To prevent conflicting changes, the current `revision` must be passed when updating the step. - name: createdDate | type: string | description: Date and time the step was created. - name: updatedDate | type: string | description: Date and time the step was updated. - name: sectionId | type: string | description: Parent section GUID. To move a step within a section or to another section, call `MoveStep`. - name: description | type: Description | description: Step title, rich text content, and optional media. - ONE-OF: - name: image | type: Image | description: Image displayed with the step content. - name: video | type: VideoV2 | description: Video displayed with the step content. - name: title | type: string | description: - name: details | type: string | description: - name: ordering | type: number | description: Step position within the section. - name: stepType | type: StepType | description: Type of content in the step. - enum: - ARTICLE: Text-based step. - VIDEO: Step with video content. - QUIZ: Step linked to a quiz. - name: extendedFields | type: ExtendedFields | description: Custom field data for the step object. - 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: programId | type: string | description: Program GUID. - name: modifiedFields | type: Map | description: Fields that were updated and their values before the update. ``` --- ## JavaScript SDK ### Schema ``` Webhook: onStepUpdated Description: Triggered when a step is updated. Payload: StepUpdatedEnvelope - name: entity | type: Step | description: none - ONE-OF: - name: videoOptions | type: VideoOptions | description: Video-specific settings. - ONE-OF: - name: wixVideo | type: WixVideo | description: Video from Wix Video. - name: _id | type: string | description: Wix Video GUID. - name: paid | type: boolean | description: Whether the Wix Video is paid content. - name: video | type: string | description: Video uploaded with Media Manager. - name: requiredCompletionPercentage | type: number | description: Percentage of the video that must be watched to complete the step. - name: coverImage | type: string | description: Cover image for the video. - name: durationInMilliseconds | type: integer | description: Video duration in milliseconds. - name: deleted | type: boolean | description: Whether the uploaded video was deleted from Media Manager. - name: quizOptions | type: QuizOptions | description: Quiz-specific settings. - name: _id | type: string | description: Quiz GUID. Provide it when creating a quiz step. After creation, the quiz reference can't be changed. - name: totalQuestions | type: integer | description: Total number of questions in the quiz. - name: passingGrade | type: number | description: Minimum percentage required to pass the quiz. - name: _id | type: string | description: Step GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the step is updated. To prevent conflicting changes, the current `revision` must be passed when updating the step. - name: _createdDate | type: Date | description: Date and time the step was created. - name: _updatedDate | type: Date | description: Date and time the step was updated. - name: sectionId | type: string | description: Parent section GUID. To move a step within a section or to another section, call `MoveStep`. - name: description | type: Description | description: Step title, rich text content, and optional media. - ONE-OF: - name: image | type: string | description: Image displayed with the step content. - name: video | type: string | description: Video displayed with the step content. - name: title | type: string | description: - name: details | type: string | description: - name: ordering | type: number | description: Step position within the section. - name: stepType | type: StepType | description: Type of content in the step. - enum: - ARTICLE: Text-based step. - VIDEO: Step with video content. - QUIZ: Step linked to a quiz. - name: extendedFields | type: ExtendedFields | description: Custom field data for the step object. - 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: programId | type: string | description: Program GUID. - 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 { steps } from '@wix/online-programs'; steps.onStepUpdated((event) => { // handle your event here }); ``` ```javascript import { createClient, AppStrategy } from '@wix/sdk'; import { steps } from '@wix/online-programs'; const wixClient = createClient({ auth: AppStrategy({ appId: 'MY-APP-ID', publicKey: 'YOUR_APP_PUBLIC_KEY', }), modules: { steps, }, }); wixClient.steps.onStepUpdated((event) => { // handle your event here }); ``` ---