This article outlines IDs you may need for API integration with third-party tools. The following table lists the IDs you can obtain via the EventHub platform.
| ID | Description |
| eventKey | A key unique to each event |
| ticketId | A unique ID for each ticket created via [Basic settings]>[Tickets/Forms] |
| customFieldId | An ID for each custom profile field created via [Basic settings]>[Profiles] |
| questionnaireId | A unique ID for each survey created via [Survey List] |
1. eventKey
Find the eventKey in the address bar of the event management, ticket sales, login, or event pages.
Ex: https://cms.eventhub.jp/e/xxxxxxxxx/eventsetting
2. ticketId
Find the ticketId in the address bar of the registration page for the respective ticket. You can copy the full URL of a ticket's registration page via [Basic settings]>[Tickets/Forms] by clicking the three dots button and selecting "Copy URL".
Ex: https://event.eventhub.jp/form/xxxxxxx-xxxx-xxxx-xxxxx-xxxxxxxxxx/formprofile?isTicketSelected=true
3. customFieldId
Find the customFieldId in the "Field ID" column of the [Basic settings]>[Profiles] table.
When creating custom profile fields, you can enter a custom [Field ID] or leave it blank to generate one automatically. Standardize the [Field ID] value for a custom profile field to simplify the API integration of that field for additional events. For example, if you plan to have a "Phone Number" profile field for multiple events, create that field for each event and assign it the same [Field ID] to simply and consistently link it to your other platforms via API integration.
<tips>[Field ID] Naming Requirements
- The first character must be a letter.
- It cannot contain only numbers.
- It must be 20 characters or less.
- Each event's field IDs must be unique, but different events can share the same field IDs.
- Field IDs are case-sensitive.</tips>
Confirming a Custom Field's Original ID
<attention>Custom field integration errors may display the default numerical [customFieldId], even when a custom [Field ID] value has been entered.
E.g., "message":"Required customFields missing: 23602"}</attention>
Check a profile field's [Field ID] and [customFieldId] by clicking the Edit mark for a field in [Basic settings]>[Profiles].
4. questionnaireId
Find the questionnaireId in the address bar of the survey page.
Ex: https://event.eventhub.jp/e/xxxxxxx/survey/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx