Developer DocumentationWebhooksJSON MessagesAttendee EmailsInvitee/Guest Email Sent

This article provides details on the ‘Invitee/Guest Email Sent’ integration point.

Note

Throughout this document and the product, the term ‘Attendee’ is used interchangeably with ‘Invitee’.

JSON Message Structure

Below is an example payload delivered when this webhook is triggered. The data represents the attendee that was sent an email.

{
  "eventType": "InviteeOrGuestEmailSent",
  "messageTime": "2044-03-01T15:37:18.437Z",
  "messageStub": "6512f44f-e0a0-405a-b745-c0100351518d",
  "message": [
    {
      "contactStub": "E05C3E26-9F14-478D-A3E5-5ED1828A7520",
      "workStateCode": "",
      "contactSourceId": "",
      "isGuest": false,
      "prefix": "",
      "workZipcode": "",
      "contactType": "",
      "updatedDate": "2044-03-01",
      "workCity": "",
      "homeCity": "",
      "profileImageUrl": "",
      "homeZipcode": "",
      "homeFax": "",
      "contactTypeStub": "00000000-0000-0000-0000-000000000000",
      "nickName": "Kay",
      "homePhone": "",
      "workFax": "",
      "eventForInvitee": {
        "eventTitle": "Frozen Yogurt Festival 2018",
        "eventLocation": "National Resort & Convention Center",
        "eventStartDate": "2018-04-30 18:00:00.0",
        "eventEndDate": "2018-04-30 22:00:00.0",
        "eventDescription": "Come try various flavors.",
        "eventCode": "4MNMDDVCR82",
        "eventPlannerFirstName": "Hannah",
        "eventPlannerLastName": "Lee",
        "eventPlannerPrefix": "",
        "eventPlannerTitle": "Regional Manager",
        "eventPlannerCompany": "Sweet Frog",
        "eventCustomFields": [
          {
            "id": "99473493-6C27-404E-A66E-67672911ED0D",
            "name": "Region",
            "value": "Northeast"
          }
        ],
        "eventTimeZoneName": "Eastern Time"
      },
      "workAddress1": "",
      "eventEmailStub": "F8F06D06-95E8-46F0-A498-CB380247E1D1",
      "workAddress2": "",
      "emailTypeId": 1,
      "firstName": "Ben",
      "workAddress3": "",
      "confirmationNumber": "",
      "mobilePhone": "",
      "responseMethod": "No Response",
      "registrationType": "",
      "eventStub": "8A2B61E2-5A8E-41F9-B702-5BBED600F48A",
      "designation": "",
      "homeCountry": "",
      "lastName": "Guy",
      "eligibleCredits": "0.00",
      "gender": "Male",
      "customFields": [
        {
          "id": "12347D26-3FBD-4ACF-BBC3-BC2ABD0608D7",
          "name": "Years of experience",
          "value": "11-15"
        },
        {
          "id": "84C1DBCA-4586-4E59-A4EA-B77F7E1FF941",
          "name": "T-shirt size",
          "value": "M"
        }
      ],
      "workCountry": "",
      "title": "CPA",
      "homeStateCode": "",
      "referenceId": "",
      "optedOut": "no",
      "totalCredits": "0.00",
      "workState": "",
      "company": "Cvent",
      "participantStatus": false,
      "accountStub": "E9CC1182-5DC5-493A-B9C5-6D626822A56E",
      "email": "example@test.com",
      "ccEmail": "",
      "contactTypeCode": "",
      "visibleOnAttendeeList": 0,
      "fullName": "Kendra Guy",
      "dateOfBirth": "",
      "homeState": "",
      "inviteeStub": "40F67D89-3272-456B-AFFB-A5B3C142AF0F",
      "invitationBy": "Planner-Invited",
      "homeAddress3": "",
      "homeAddress2": "",
      "unsubscribed": "no",
      "workCountryCode": "",
      "homeAddress1": "",
      "inviteeStatus": "No Response",
      "internalNote": "",
      "middleName": "",
      "workPhone": ""
    }
  ]
}
Note

The integration sends a webhook message whether or not the email was sucessfully delivered.

Understanding the JSON Message

  • Arrays: The customFields, eventCustomFields, orders arrays are dynamic; they changes over time as planners add or remove custom fields, and the attendee adds elements to their order.
  • Empty Fields: Fields appearing as empty ("") indicate no data is available for that field.
Last updated on