> 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: contacts # Namespace: extendedFields # Webhook link: https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/extended-fields/extended-field-created.md ## Introduction Triggered when an extended field is created. --- ## REST API ### Schema ``` Webhook: Extended Field Created Description: Triggered when an extended field 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: ExtendedField | description: The created entity. - name: namespace | type: string | description: Extended field namespace. Extended fields created through by calling the Find Or Create Extended Field method are automatically assigned to the `custom` namespace. - name: key | type: string | description: Extended field key. When accessing contact data, extended field data is available at `extendedFields[key]`. For example, if the key is "custom.notes", the value can be accessed at `extendedFields["custom.notes"]`. `key` is generated when the extended field is created and can't be modified, even if `displayName` changes. - name: displayName | type: string | description: Display name shown in the contact list. - name: dataType | type: FieldDataType | description: Type of data the field holds. - enum: - TEXT: Accepts strings. - NUMBER: Accepts floats. - DATE: Accepts dates formatted as `YYYY-MM-DD`. - URL: Accepts strings. Prepends `https://` if no protocol is included. - name: fieldType | type: FieldType | description: Indicates whether the extended field is a system field or custom field. - enum: - SYSTEM: Field is a system field managed by Wix. System fields can't be modified by calling the Update Extended Field method. - USER_DEFINED: Field is a custom field and can be modified by calling the Update Extended Field method. - name: createdDate | type: string | description: Date and time the field was created. - name: updatedDate | type: string | description: Date and time the field was last updated. - name: description | type: string | description: Field description, if the field is a system field. ``` ### Examples ```curl { "id": "5e0e6a26-eb25-49eb-b5fe-a680d463764e", "entityFqdn": "wix.contacts.v4.extended_field", "slug": "created", "entityId": "custom.example", "createdEvent": { "entity": { "namespace": "custom", "key": "custom.example", "displayName": "example", "dataType": "TEXT", "fieldType": "USER_DEFINED", "createdDate": "2020-10-19T07:33:28.071Z", "updatedDate": "2020-10-19T07:33:28.071Z", "legacyId": "cc17c4fb-07d1-4eb1-a67c-09375bb05595" } }, "eventTime": "2020-10-19T07:33:28.683009Z", "triggeredByAnonymizeRequest": false } ``` --- ## JavaScript SDK ### Schema ``` Webhook: onExtendedFieldCreated Description: Triggered when an extended field is created. Payload: ExtendedFieldCreatedEnvelope - name: entity | type: ExtendedField | description: none - name: namespace | type: string | description: Extended field namespace. Extended fields created through by calling the Find Or Create Extended Field method are automatically assigned to the `custom` namespace. - name: key | type: string | description: Extended field key. When accessing contact data, extended field data is available at `extendedFields[key]`. For example, if the key is "custom.notes", the value can be accessed at `extendedFields["custom.notes"]`. `key` is generated when the extended field is created and can't be modified, even if `displayName` changes. - name: displayName | type: string | description: Display name shown in the contact list. - name: dataType | type: FieldDataType | description: Type of data the field holds. - enum: - TEXT: Accepts strings. - NUMBER: Accepts floats. - DATE: Accepts dates formatted as `YYYY-MM-DD`. - URL: Accepts strings. Prepends `https://` if no protocol is included. - name: fieldType | type: FieldType | description: Indicates whether the extended field is a system field or custom field. - enum: - SYSTEM: Field is a system field managed by Wix. System fields can't be modified by calling the Update Extended Field method. - USER_DEFINED: Field is a custom field and can be modified by calling the Update Extended Field method. - name: _createdDate | type: Date | description: Date and time the field was created. - name: _updatedDate | type: Date | description: Date and time the field was last updated. - name: description | type: string | description: Field description, if the field is a system field. - 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 { extendedFields } from '@wix/crm'; extendedFields.onExtendedFieldCreated((event) => { // handle your event here }); ``` ```javascript import { createClient, AppStrategy } from '@wix/sdk'; import { extendedFields } from '@wix/crm'; const wixClient = createClient({ auth: AppStrategy({ appId: 'MY-APP-ID', publicKey: 'YOUR_APP_PUBLIC_KEY', }), modules: { extendedFields, }, }); wixClient.extendedFields.onExtendedFieldCreated((event) => { // handle your event here }); ``` ---