> 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: onlineOrders # Namespace: notificationRecipients # Webhook link: https://dev.wix.com/docs/api-reference/business-solutions/restaurants/online-orders/notification-recipients/recipient-deleted.md ## Introduction # Webhook Permissions Scopes IDs: Manage Restaurants - all permissions: SCOPE.RESTAURANTS.MEGA-SCOPES --- ## REST API ### Schema ``` Webhook: Recipient Deleted Description: 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. ``` ### Examples ```curl { "id": "event_11111111-2222-3333-4444-555555555555", "entityFqdn": "wix.restaurants.recipient.v1.recipient", "slug": "deleted", "eventTime": "2024-01-15T16:20:00.000Z", "triggeredByAnonymizeRequest": false, "entityId": "12345678-1234-1234-1234-123456789012", "entityAsJson": null, "deletedEntityAsJson": "{\"id\":\"12345678-1234-1234-1234-123456789012\",\"revision\":2,\"phone\":\"+1-555-987-6543\",\"businessLocationIds\":[\"550e8400-e29b-41d4-a716-446655440000\"],\"channels\":[\"SMS\"],\"tags\":{\"publicTags\":{\"tagIds\":[\"VIP\",\"PREMIUM_CUSTOMER\",\"LOYALTY_MEMBER\"]}},\"extendedFields\":{\"namespaces\":{\"custom\":{\"customerName\":\"John Smith\",\"preferredLanguage\":\"es\",\"timezone\":\"America/Los_Angeles\",\"loyaltyPoints\":\"1250\"}}},\"createdDate\":\"2024-01-15T10:30:00.000Z\",\"updatedDate\":\"2024-01-15T14:45:00.000Z\"}", "actionEvent": { "bodyAsJson": "{}" } } ``` --- ## JavaScript SDK ### Schema ``` Webhook: onRecipientDeleted Description: Payload: RecipientDeletedEnvelope - name: entity | type: Recipient | description: none - name: _id | type: string | description: Recipient GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the Recipient is updated. To prevent conflicting changes, the current revision must be passed when updating the Recipient. Ignored when creating a Recipient. - name: _createdDate | type: Date | description: Date and time the Recipient was created. - name: _updatedDate | type: Date | description: Date and time the Recipient was last updated. - name: phone | type: string | description: Recipient's phone number for receiving notifications. - name: businessLocationIds | type: array | description: IDs of the business locations this recipient should receive order creation notifications for. If this list is empty the recipient receives notifications for orders created at all locations. - name: channels | type: array | description: Communication channels for sending notifications to the recipient. At least 1 channel is required. Recipients can receive notifications through multiple channels simultaneously. - enum: - SMS: Send notifications via SMS text messages. - PHONE: Send notifications via phone calls. - name: note | type: string | description: Additional information about the recipient. Use this field to store notes about the recipient's role, availability, or other relevant details for notification management. - name: extendedFields | type: ExtendedFields | description: Additional custom fields for the recipient. - 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: Tags | description: Tags for categorizing and organizing recipients. Use tags to group recipients by role (manager, kitchen staff), shift (morning, evening), or other criteria for targeted notifications. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs. - name: publicTags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. - 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 { recipients } from '@wix/restaurants'; recipients.onRecipientDeleted((event) => { // handle your event here }); ``` ```javascript import { createClient, AppStrategy } from '@wix/sdk'; import { recipients } from '@wix/restaurants'; const wixClient = createClient({ auth: AppStrategy({ appId: 'MY-APP-ID', publicKey: 'YOUR_APP_PUBLIC_KEY', }), modules: { recipients, }, }); wixClient.recipients.onRecipientDeleted((event) => { // handle your event here }); ``` ---