Use webhooks to automatically send data from EventHub to external systems in real time whenever a specific trigger occurs, such as user registrations or QR check-ins.
1. Available Webhooks
❶ Event creation
Trigger: When a new event is created or duplicated, including exhibitor events
| Property | Description |
| eventId | An ID that uniquely identifies the event |
| eventKey | A key unique to each event |
| eventNameJa | The Japanese event name (as applicable) |
| eventNameEn | The English event name (as applicable) |
| isExhibition | Exhibitor event: true Standard event: false |
| eventType | The set [Event type] Seminar / Conference / Other |
| from | The event start date/time |
| to | The event end date/time |
| timezone | The event's time zone |
| expire | The [Event page closing date] |
| senderName | The event [Organizer name] |
| replyEmail | The [Organizer email address] |
| createdAt | The date/time the event was created |
| contractId | The ID of the event's associated contract |
| ticketId | An ID unique to each ticket Displays the ID for the top ticket on the [Tickets/Forms] list |
❷ User registration
Trigger: When a user registers for any event via one of the following methods:
- An EventHub ticket
- An embedded registration form
- An exhibitor event lead form
| Property | Description |
| userId | An ID unique to each user |
| eventKey | A key unique to each event |
| eventId | An ID that uniquely identifies the event |
| eventNameJa | The Japanese event name (as applicable) |
| eventNameEn | The English event name (as applicable) |
| isExhibition | Exhibitor event: true Standard event: false |
| eventType | The set [Event type] Seminar / Conference / Other |
| ticketId | An ID unique to each ticket |
| The user's email address | |
| userType | "Attendee" or "Exhibitor" based on the user's registration |
| language | The user's registration language |
| portraitUrl | The URL to a user's profile photo |
| utmSource | The UTM source |
| utmMedium | The medium (media type) |
| utmCampaign | The campaign name |
| utmTerm | The keyword |
| utmContent | The ad content specification |
| userName | The user's full name *Both properties return the same value. As [name] remains for existing compatibility purposes, please reference [userName] for new integration. |
| name | |
| familyName | The user's last name |
| givenName | The user's first name |
| affiliation | The user's company or affiliation |
| department | The user's department |
| position | The user's title or position |
| companyId | The booth ID for exhibitors linked to one |
| customFieldXXXX | The [Field ID] for custom profiles set via [Basic settings]>[Profiles] The "XXXX" is replaced by the customFieldId |
❸ Session registration
Trigger: When a user registers for any session as outlined below.
- From the event page: When a user clicks the [Register] button for a session on the [Programs] tab. Also triggers when unregistering for a session.
- During registration: After selecting to attend a session during registration and completing registration by clicking [Register]. The [Enable session signup during registration] setting must be enabled for users to access this option.
| Property | Description |
| eventId | An ID that uniquely identifies the event |
| eventKey | A key unique to each event |
| eventNameJa | The Japanese event name (as applicable) |
| eventNameEn | The English event name (as applicable) |
| isExhibition | Exhibitor event: true Standard event: false |
| eventType | The set [Event type] Seminar / Conference / Other |
| userId | An ID unique to each user |
| The user's email address | |
| userType | "Attendee" or "Exhibitor" based on the user's registration |
| language | The user's registration language |
| portraitUrl | The URL to a user's profile photo |
| utmSource | The UTM source |
| utmMedium | The medium (media type) |
| utmCampaign | The campaign name |
| utmTerm | The keyword |
| utmContent | The ad content specification |
| userName | The user's full name |
| familyName | The user's last name |
| givenName | The user's first name |
| affiliation | The user's company or affiliation |
| department | The user's department |
| position | The user's title or position |
| sessionId | The session ID |
| sessionNameJa | The Japanese session name (as applicable) |
| sessionNameEn | The English session name (as applicable) |
| status | Upon registering: register Upon cancelling registration: cancel |
❹ Virtual attendance
Trigger: When a user visits the event page for the first time during an event's duration
| Property | Description |
| eventId | An ID that uniquely identifies the event |
| eventKey | A key unique to each event |
| eventNameJa | The Japanese event name (as applicable) |
| eventNameEn | The English event name (as applicable) |
| isExhibition | Exhibitor event: true Standard event: false |
| eventType | The set [Event type] Seminar / Conference / Other |
| userId | An ID unique to each user |
| The user's email address | |
| userType | "Attendee" or "Exhibitor" based on the user's registration |
| language | The user's registration language |
| portraitUrl | The URL to a user's profile photo |
| utmSource | The UTM source |
| utmMedium | The medium (media type) |
| utmCampaign | The campaign name |
| utmTerm | The keyword |
| utmContent | The ad content specification |
| userName | The user's full name *Both properties return the same value. As [name] remains for existing compatibility purposes, please reference [userName] for new integration. |
| name | |
| familyName | The user's last name |
| givenName | The user's first name |
| affiliation | The user's company or affiliation |
| department | The user's department |
| position | The user's title or position |
| attendedAt | When the user visited the event page |
<tips>Virtual attendance is calculated once a registrant visits the event page between the start and end date/time set via [Basic settings]>[Event information]>[Schedule settings].</tips>
❺ QR check in
Trigger: When a user successfully scans their QR code at a QR check-in point in any event
| Property | Description |
| eventId | An ID that uniquely identifies the event |
| eventKey | A key unique to each event |
| eventNameJa | The Japanese event name (as applicable) |
| eventNameEn | The English event name (as applicable) |
| isExhibition | Exhibitor event: true Standard event: false |
| eventType | The set [Event type] Seminar / Conference / Other |
| ticketId | An ID unique to each ticket |
| userId | An ID unique to each user |
| The user's email address | |
| userType | "Attendee" or "Exhibitor" based on the user's registration |
| language | The user's registration language |
| userName | The user's full name |
| familyName | The user's last name |
| givenName | The user's first name |
| affiliation | The user's company or affiliation |
| department | The user's department |
| position | The user's title or position |
| portraitUrl | The URL to a user's profile photo |
| utmSource | The UTM source |
| utmMedium | The medium (media type) |
| utmCampaign | The campaign name |
| utmTerm | The keyword |
| utmContent | The ad content specification |
| isStaff | The user's staff setting, set via [Attendees]/[Exhibitors]>[User list]>[Staff settings] On / Off |
| checkinPointId | The check-in point's ID |
| category | The check-in point's [Category] Entry / Exit / Session / Booth |
| checkinPointCompanyId | The booth ID for [Booth] category check-in points |
| checkinPointSessionId | The session ID for [Session] category check-in points |
| memo | The check-in point's [Point details] |
❻ Archive video viewed
Trigger: When a user watches an archive video for the set amount of time. The set interval applies to all archive videos across all events.
| Property | Description |
| eventId | An ID that uniquely identifies the event |
| eventKey | A key unique to each event |
| eventNameJa | The Japanese event name (as applicable) |
| eventNameEn | The English event name (as applicable) |
| isExhibition | Exhibitor event: true Standard event: false |
| eventType | The set [Event type] Seminar / Conference / Other |
| userId | An ID unique to each user |
| userType | "Attendee" or "Exhibitor" based on the user's registration |
| language | The user's registration language |
| The user's email address | |
| userName | The user's full name |
| familyName | The user's last name |
| givenName | The user's first name |
| affiliation | The user's company or affiliation |
| department | The user's department |
| position | The user's title or position |
| portraitUrl | The URL to a user's profile photo |
| utmSource | The UTM source |
| utmMedium | The medium (media type) |
| utmCampaign | The campaign name |
| utmTerm | The keyword |
| utmContent | The ad content specification |
| archiveVideoId |
The video ID listed at the end of the URL on the event page |
| captionJa | The Japanese video title (as applicable) |
| captionEn | The English video title (as applicable) |
| totalMinutes | The total number of minutes watched |
❼ Booth document download
Trigger: When a user downloads a document from a booth page
| Property | Description |
| eventId | An ID that uniquely identifies the event |
| eventKey | A key unique to each event |
| eventNameJa | The Japanese event name (as applicable) |
| eventNameEn | The English event name (as applicable) |
| isExhibition | Exhibitor event: true Standard event: false |
| eventType | The set [Event type] Seminar / Conference / Other |
| userId | An ID unique to each user |
| The user's email address | |
| userType | "Attendee" or "Exhibitor" based on the user's registration |
| language | The user's registration language |
| userName | The user's full name *Both properties return the same value. As [name] remains for existing compatibility purposes, please reference [userName] for new integration. |
| name | |
| familyName | The user's last name |
| givenName | The user's first name |
| affiliation | The user's company or affiliation |
| department | The user's department |
| position | The user's title or position |
| portraitUrl | The URL to a user's profile photo |
| utmSource | The UTM source |
| utmMedium | The medium (media type) |
| utmCampaign | The campaign name |
| utmTerm | The keyword |
| utmContent | The ad content specification |
| companyMaterialId | The booth's attached file ID |
| companyId | The booth ID |
| title | The file title displayed on the booth page |
| thumbnailUrl | The URL to the file's thumbnail image |
| fileName | The file name |
❽ Session document download
Trigger: When a user downloads a document from a session's info
| Property | Description |
| eventId | An ID that uniquely identifies the event |
| eventKey | A key unique to each event |
| eventNameJa | The Japanese event name (as applicable) |
| eventNameEn | The English event name (as applicable) |
| isExhibition | Exhibitor event: true Standard event: false |
| eventType | The set [Event type] Seminar / Conference / Other |
| userId | An ID unique to each user |
| userType | "Attendee" or "Exhibitor" based on the user's registration |
| language | The user's registration language |
| The user's email address | |
| userName | The user's full name |
| familyName | The user's last name |
| givenName | The user's first name |
| affiliation | The user's company or affiliation |
| department | The user's department |
| position | The user's title or position |
| portraitUrl | The URL to a user's profile photo |
| utmSource | The UTM source |
| utmMedium | The medium (media type) |
| utmCampaign | The campaign name |
| utmTerm | The keyword |
| utmContent | The ad content specification |
| sessionId | The session ID |
| sessionNameJa | The Japanese session name (as applicable) |
| sessionNameEn | The English session name (as applicable) |
| sessionMaterialId | The session's attached file ID |
| title | The file title displayed in the session info |
| thumbnailUrl | The URL to the file's thumbnail image |
| fileName | The file name |
❾ Live comment post
Trigger: When a user submits a comment on a video stream
| Property | Description |
| eventId | An ID that uniquely identifies the event |
| eventKey | A key unique to each event |
| eventNameJa | The Japanese event name (as applicable) |
| eventNameEn | The English event name (as applicable) |
| isExhibition | Exhibitor event: true Standard event: false |
| eventType | The set [Event type] Seminar / Conference / Other |
| userId | An ID unique to each user |
| The user's email address | |
| userType | "Attendee" or "Exhibitor" based on the user's registration |
| language | The user's registration language |
| portraitUrl | The URL to a user's profile photo |
| utmSource | The UTM source |
| utmMedium | The medium (media type) |
| utmCampaign | The campaign name |
| utmTerm | The keyword |
| utmContent | The ad content specification |
| userName | The user's full name |
| familyName | The user's last name |
| givenName | The user's first name |
| affiliation | The user's company or affiliation |
| department | The user's department |
| position | The user's title or position |
| videoId | The ID of the video steam channel |
| videoNameJa | The Japanese channel name (as applicable) |
| videoNameEn | The English channel name (as applicable) |
| text | The content of the comment |
| isAnonymous | Anonymous: true Show name: false |
➓ Survey response
Trigger: When a user responds to a survey in any event
| Property | Description |
| questionnaireId | An ID unique to each survey in the [Survey list] |
| questionnaireTitleJa | The Japanese survey name (as applicable) |
| questionnaireTitleEn | The English survey name (as applicable) |
| eventId | An ID that uniquely identifies the event |
| eventKey | A key unique to each event |
| eventNameJa | The Japanese event name (as applicable) |
| eventNameEn | The English event name (as applicable) |
| isExhibition | Exhibitor event: true Standard event: false |
| eventType | The set [Event type] Seminar / Conference / Other |
| userId | An ID unique to each user |
| The user's email address | |
| userType | "Attendee" or "Exhibitor" based on the user's registration |
| language | The user's registration language |
| portraitUrl | The URL to a user's profile photo |
| utmSource | The UTM source |
| utmMedium | The medium (media type) |
| utmCampaign | The campaign name |
| utmTerm | The keyword |
| utmContent | The ad content specification |
| userName | The user's full name *Both properties return the same value. As [name] remains for existing compatibility purposes, please reference [userName] for new integration. |
| name | |
| familyName | The user's last name |
| givenName | The user's first name |
| affiliation | The user's company or affiliation |
| department | The user's department |
| position | The user's title or position |
| questionXXXJa, questionXXXEn |
A survey question The "XXX" is replaced by the question number (001, 002, etc.) |
| answerXXXJa, answerXXXEn |
The response to a given question The "XXX" is replaced by the question number (001, 002, etc.) |
2. How to Set Up a Webhook
① Click [Settings] in the top menu bar of the EventHub admin page.
② Click [External integrations] and select [Webhook].
③ Select a webhook and click [Edit].
④ Enter the applicable URL for the notifications and click [Save].
⑤ The webhook setup is now complete. Information will be sent automatically to the webhook's URL when the trigger is activated.
<tips>Use the [Enabled] toggle to turn webhooks off and on.</tips>
3. Additional Notes
- The webhooks outlined above trigger for each event on the admin page. To target a specific event, specify the corresponding eventId when configuring the notifications.
- See the following article for additional reference about the eventKey property: API Integration IDs