> 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: branches # Webhook link: https://dev.wix.com/docs/api-reference/business-management/branches/branch-created.md ## Introduction Triggered when a branch is created. --- ## REST API ### Schema ``` Webhook: Branch Created Description: Triggered when a branch is created. 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: createdEvent | type: object | description: Created event details. - name: entity | type: Branch | description: The created entity. - ONE-OF: - name: sourceBranchProperties | type: SourceBranch | description: Source branch properties. Use when `sourceType` = `SOURCE_BRANCH`. - name: branchId | type: string | description: Source branch GUID. - name: branchRevision | type: string | description: Revision number of the source branch when this branch was created. To prevent conflicting changes, the current revision must be passed when updating the branch. - name: sourceTemplateProperties | type: SourceTemplate | description: Source template properties. Use when `sourceType` = `SOURCE_TEMPLATE`. - name: templateId | type: string | description: Source template GUID. - name: id | type: string | description: Branch GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the branch is updated. To prevent conflicting changes, the current revision must be passed when updating the branch. - name: type | type: Type | description: Branch type. - enum: - USER: A branch created by a site owner that can be accessed for editing and publishing in the editor. - TECHNICAL: A branch created for technical purposes, unrelated to site owners. For internal use, can't be accessed in the editor. - ORIGINAL_BRANCH: The original branch of the site, created when the site is created. Can be accessed for editing and publishing in the editor. - name: name | type: string | description: Branch name. - name: sourceType | type: SourceType | description: Source type for this branch's content. Must be aligned with the corresponding source properties below. - enum: - SOURCE_BRANCH: This branch's source was another branch. Must be used with `sourceBranchProperties`. - name: lastPublishDate | type: string | description: Date and time the branch was last published. - name: editorType | type: EditorType | description: Wix editor type. - name: editorTypeOptions | type: EditorTypeOptions | description: Wix editor types. - enum: - STUDIO: Wix Studio Editor. - CLASSIC: Wix's Classic Editor. - name: default | type: boolean | description: Whether this branch is the default branch. The default branch is used for API operations when no branch GUID is specified. - name: createdDate | type: string | description: Date and time the branch was created. - name: updatedDate | type: string | description: Date and time the branch was last updated. - name: extendedFields | type: ExtendedFields | description: Custom field data for the branch. [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md) must be configured in the app dashboard before they can be accessed with API calls. - 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: tags | type: PublicTags | description: Public tags assigned to the branch. - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. - name: tagIds | type: array | description: List of tag GUIDs. ``` ### Examples ```curl { "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa", "entityFqdn": "wix.editor.branches.v1.branch", "slug": "created", "entityId": "11111111-1111-1111-1111-111111111111", "createdEvent": { "entity": { "id": "22222222-2222-2222-2222-222222222222", "revision": 1, "type": "USER", "sourceType": "SOURCE_BRANCH", "sourceBranchProperties": { "branchId": "00000000-0000-0000-0000-000000000000" }, "createdDate": "2025-01-15T16:16:27.426Z", "updatedDate": "2025-01-15T16:16:27.426Z" } }, "eventTime": "2025-01-15T16:16:27.433486291Z", "triggeredByAnonymizeRequest": false, "entityEventSequence": "1" } ``` --- ## JavaScript SDK ### Schema ``` Webhook: onBranchCreated Description: Triggered when a branch is created. Payload: BranchCreatedEnvelope - name: entity | type: Branch | description: none - ONE-OF: - name: sourceBranchProperties | type: SourceBranch | description: Source branch properties. Use when `sourceType` = `SOURCE_BRANCH`. - name: branchId | type: string | description: Source branch GUID. - name: branchRevision | type: string | description: Revision number of the source branch when this branch was created. To prevent conflicting changes, the current revision must be passed when updating the branch. - name: sourceTemplateProperties | type: SourceTemplate | description: Source template properties. Use when `sourceType` = `SOURCE_TEMPLATE`. - name: templateId | type: string | description: Source template GUID. - name: _id | type: string | description: Branch GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the branch is updated. To prevent conflicting changes, the current revision must be passed when updating the branch. - name: type | type: Type | description: Branch type. - enum: - USER: A branch created by a site owner that can be accessed for editing and publishing in the editor. - TECHNICAL: A branch created for technical purposes, unrelated to site owners. For internal use, can't be accessed in the editor. - ORIGINAL_BRANCH: The original branch of the site, created when the site is created. Can be accessed for editing and publishing in the editor. - name: name | type: string | description: Branch name. - name: sourceType | type: SourceType | description: Source type for this branch's content. Must be aligned with the corresponding source properties below. - enum: - SOURCE_BRANCH: This branch's source was another branch. Must be used with `sourceBranchProperties`. - name: lastPublishDate | type: string | description: Date and time the branch was last published. - name: editorType | type: EditorType | description: Wix editor type. - name: editorTypeOptions | type: EditorTypeOptions | description: Wix editor types. - enum: - STUDIO: Wix Studio Editor. - CLASSIC: Wix's Classic Editor. - name: default | type: boolean | description: Whether this branch is the default branch. The default branch is used for API operations when no branch GUID is specified. - name: _createdDate | type: Date | description: Date and time the branch was created. - name: _updatedDate | type: Date | description: Date and time the branch was last updated. - name: extendedFields | type: ExtendedFields | description: Custom field data for the branch. [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md) must be configured in the app dashboard before they can be accessed with API calls. - 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: tags | type: PublicTags | description: Public tags assigned to the branch. - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. - name: tagIds | type: array | description: List of tag GUIDs. - 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 { branches } from '@wix/editor-branches'; branches.onBranchCreated((event) => { // handle your event here }); ``` ```javascript import { createClient, AppStrategy } from '@wix/sdk'; import { branches } from '@wix/editor-branches'; const wixClient = createClient({ auth: AppStrategy({ appId: 'MY-APP-ID', publicKey: 'YOUR_APP_PUBLIC_KEY', }), modules: { branches, }, }); wixClient.branches.onBranchCreated((event) => { // handle your event here }); ``` ---