> 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: registration

# Namespace: eventGuests

# Webhook link: https://dev.wix.com/docs/api-reference/business-solutions/events/registration/event-guests/event-guest-created.md

## Introduction

Triggered when a guest is created.

---

## REST API

### Schema

```
Webhook: Event Guest Created
Description: Triggered when a guest 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: EventGuest | description: The created entity.
        - name: id | type: string | description: Guest GUID.
        - name: eventId | type: string | description: Event GUID.
        - name: rsvpId | type: string | description: RSVP GUID. <br/> <br/> **Note:** Only applicable when `guestType` is `"RSVP"`.
        - name: orderNumber | type: string | description: Order number. <br/> <br/> **Note:** Only applicable when `guestType` is `"BUYER"` or `"TICKET_HOLDER"`.
        - name: ticketNumber | type: string | description: Ticket number. <br/> <br/> **Note:** Only applicable when `guestType` is `"TICKET_HOLDER"`.
        - name: tickets | type: array<TicketDetails> | description: List of names, numbers, and definition GUIDs for each ticket.
           - name: number | type: string | description: Ticket number.
           - name: definitionId | type: string | description: Ticket definition GUID.
           - name: name | type: string | description: Ticket name.
        - name: contactId | type: string | description: Guest's contact GUID. See the Contacts API for more details.
        - name: guestDetails | type: GuestDetails | description: Guest details. <br/> <br/> Returned only when the `guestDetails` fieldset is sent in the request.
           - name: email | type: string | description: Email.
           - name: firstName | type: string | description: First name.
           - name: lastName | type: string | description: Last name.
           - name: formResponse | type: FormResponse | description: Form response.
              - name: inputValues | type: array<InputValue> | description: Form field inputs.
                 - name: inputName | type: string | description: Form field input name.
                 - name: value | type: string | description: Form field value.
                 - name: values | type: array | description: Form field values.
           - name: checkedIn | type: boolean | description: Whether the guest has checked into the event.
           - name: onlineConferencingLogin | type: OnlineConferencingLogin | description: The login details for the guest to access the online conference event.
              - name: link | type: string | description: Link URL to the online conference.
              - name: password | type: string | description: Password for the online conference.
           - name: phone | type: string | description: Phone extracted from form response. If multiples phone inputs are present, first one is returned.
           - name: address | type: string | description: Address extracted from form response. If multiples address inputs are present, first one is returned.
        - name: attendanceStatus | type: AttendanceStatus | description: Attendance status. The attendance status updates based on status values in an RSVP object (for RSVP events) or in an Order object (for ticketed events). For more information, see [Guest Attendance Status Mapping](https://dev.wix.com/docs/api-reference/business-solutions/events/registration/event-guests/guest-attendance-status-mapping.md). <br/> <br/> **Note:** For `guestType` of `"BUYER"` or `"TICKET_HOLDER"` the `"IN_WAITLIST"` value is not applicable.
           - enum:
           -     NOT_ATTENDING: Not attending.
           -     ATTENDING: Attending.
           -     IN_WAITLIST: In a waiting list.
        - name: secondaryLanguageCode | type: string | description: Secondary language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Used when the event ticket should be translated into another language.
        - name: createdDate | type: string | description: Date and time the guest was created in `yyyy-mm-ddThh:mm:sssZ` format.
        - name: updatedDate | type: string | description: Date and time the guest was updated in `yyyy-mm-ddThh:mm:sssZ` format.
        - name: attendanceStatusUpdatedDate | type: string | description: Date and time of guest's latest attendance status update.
        - name: memberId | type: string | description: Site member GUID.
        - name: guestType | type: GuestType | description: Guest type.
           - enum:
           -     RSVP: An invited guest, no ticket necessary.
           -     BUYER: The guest who bought the ticket.
           -     TICKET_HOLDER: The guest for whom the ticket was bought.
        - name: locale | type: string | description: Locale in [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format. Used when the event date and time on a ticket should be formatted into another locale.
        - name: totalGuests | type: integer | description: Number of total guests in an event (registered guests + additional ones).
        - name: revision | type: string | description: Revision number, which increments by 1 each time the guest is updated.
        - name: additionalDetails | type: AdditionalDetails | description: Additional Details
           - name: createdDate | type: string | description: Date and time the source entity (RSVP or Order) was created.
           - name: updatedDate | type: string | description: Date and time the source entity (RSVP or Order) was updated.
           - name: rsvpStatus | type: RsvpStatus | description: Rsvp Status
               - enum:
               -     YES: Guest is attending the event.
               -     NO: Guest isn't attending the event.
               -     WAITLIST: Guest is on a waitlist.
           - name: orderStatus | type: OrderStatus | description: Order Status
               - enum:
               -     UNKNOW_ORDER_STATUS: Order status is not available for this request fieldset.
               -     FREE: Order is confirmed, no payment is required.
               -     PENDING: Order was paid, but the payment gateway suspended the payment.
               -     PAID: Order is paid.
               -     OFFLINE_PENDING: Order is confirmed but has be paid via offline payment. Status needs to be manually updated to `"PAID"`.
               -     INITIATED: Order is awaiting for payment at the cashier.
               -     CANCELED: Order is canceled.
               -     DECLINED: Order payment is declined.
               -     AUTHORIZED: Order payment is authorized.
               -     VOIDED: Order payment is voided.
               -     PARTIALLY_PAID: Order is partially paid with less than the total amount.

```

---

## JavaScript SDK

### Schema

```
Webhook: onGuestCreated
Description: Triggered when a guest is created.
Payload: GuestCreatedEnvelope
  - name: entity | type: EventGuest | description: none
     - name: _id | type: string | description: Guest GUID.
     - name: eventId | type: string | description: Event GUID.
     - name: rsvpId | type: string | description: RSVP GUID. <br/> <br/> **Note:** Only applicable when `guestType` is `"RSVP"`.
     - name: orderNumber | type: string | description: Order number. <br/> <br/> **Note:** Only applicable when `guestType` is `"BUYER"` or `"TICKET_HOLDER"`.
     - name: ticketNumber | type: string | description: Ticket number. <br/> <br/> **Note:** Only applicable when `guestType` is `"TICKET_HOLDER"`.
     - name: tickets | type: array<TicketDetails> | description: List of names, numbers, and definition GUIDs for each ticket.
        - name: number | type: string | description: Ticket number.
        - name: definitionId | type: string | description: Ticket definition GUID.
        - name: name | type: string | description: Ticket name.
     - name: contactId | type: string | description: Guest's contact GUID. See the Contacts API for more details.
     - name: guestDetails | type: GuestDetails | description: Guest details. <br/> <br/> Returned only when the `guestDetails` fieldset is sent in the request.
        - name: email | type: string | description: Email.
        - name: firstName | type: string | description: First name.
        - name: lastName | type: string | description: Last name.
        - name: formResponse | type: FormResponse | description: Form response.
           - name: inputValues | type: array<InputValue> | description: Form field inputs.
              - name: inputName | type: string | description: Form field input name.
              - name: value | type: string | description: Form field value.
              - name: values | type: array | description: Form field values.
        - name: checkedIn | type: boolean | description: Whether the guest has checked into the event.
        - name: onlineConferencingLogin | type: OnlineConferencingLogin | description: The login details for the guest to access the online conference event.
           - name: link | type: string | description: Link URL to the online conference.
           - name: password | type: string | description: Password for the online conference.
        - name: phone | type: string | description: Phone extracted from form response. If multiples phone inputs are present, first one is returned.
        - name: address | type: string | description: Address extracted from form response. If multiples address inputs are present, first one is returned.
     - name: attendanceStatus | type: AttendanceStatus | description: Attendance status. The attendance status updates based on status values in an RSVP object (for RSVP events) or in an Order object (for ticketed events). For more information, see [Guest Attendance Status Mapping](https://dev.wix.com/docs/api-reference/business-solutions/events/registration/event-guests/guest-attendance-status-mapping.md). <br/> <br/> **Note:** For `guestType` of `"BUYER"` or `"TICKET_HOLDER"` the `"IN_WAITLIST"` value is not applicable.
         - enum:
         -     NOT_ATTENDING: Not attending.
         -     ATTENDING: Attending.
         -     IN_WAITLIST: In a waiting list.
     - name: secondaryLanguageCode | type: string | description: Secondary language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Used when the event ticket should be translated into another language.
     - name: _createdDate | type: Date | description: Date and time the guest was created in `yyyy-mm-ddThh:mm:sssZ` format.
     - name: _updatedDate | type: Date | description: Date and time the guest was updated in `yyyy-mm-ddThh:mm:sssZ` format.
     - name: attendanceStatusUpdatedDate | type: Date | description: Date and time of guest's latest attendance status update.
     - name: memberId | type: string | description: Site member GUID.
     - name: guestType | type: GuestType | description: Guest type.
         - enum:
         -     RSVP: An invited guest, no ticket necessary.
         -     BUYER: The guest who bought the ticket.
         -     TICKET_HOLDER: The guest for whom the ticket was bought.
     - name: locale | type: string | description: Locale in [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format. Used when the event date and time on a ticket should be formatted into another locale.
     - name: totalGuests | type: integer | description: Number of total guests in an event (registered guests + additional ones).
     - name: revision | type: string | description: Revision number, which increments by 1 each time the guest is updated.
     - name: additionalDetails | type: AdditionalDetails | description: Additional Details
        - name: _createdDate | type: Date | description: Date and time the source entity (RSVP or Order) was created.
        - name: _updatedDate | type: Date | description: Date and time the source entity (RSVP or Order) was updated.
        - name: rsvpStatus | type: RsvpStatus | description: Rsvp Status
             - enum:
             -     YES: Guest is attending the event.
             -     NO: Guest isn't attending the event.
             -     WAITLIST: Guest is on a waitlist.
        - name: orderStatus | type: OrderStatus | description: Order Status
             - enum:
             -     UNKNOW_ORDER_STATUS: Order status is not available for this request fieldset.
             -     FREE: Order is confirmed, no payment is required.
             -     PENDING: Order was paid, but the payment gateway suspended the payment.
             -     PAID: Order is paid.
             -     OFFLINE_PENDING: Order is confirmed but has be paid via offline payment. Status needs to be manually updated to `"PAID"`.
             -     INITIATED: Order is awaiting for payment at the cashier.
             -     CANCELED: Order is canceled.
             -     DECLINED: Order payment is declined.
             -     AUTHORIZED: Order payment is authorized.
             -     VOIDED: Order payment is voided.
             -     PARTIALLY_PAID: Order is partially paid with less than the total amount.
  - 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 { guests } from '@wix/events';

guests.onGuestCreated((event) => {
    // handle your event here
});
```


```javascript
import { createClient, AppStrategy } from '@wix/sdk';
import { guests } from '@wix/events';

const wixClient = createClient({
  auth: AppStrategy({
    appId: 'MY-APP-ID',
    publicKey: 'YOUR_APP_PUBLIC_KEY',
  }),
  modules: {
      guests,
    },
});

wixClient.guests.onGuestCreated((event) => {
    // handle your event here
});
```

---