Community admins may setup outbound webhooks for certain events such as user activities, event creations, etc. On occurrence of these events Gradual will send HTTP POST requests to given webhook URLs with relevant data in the payload.
Webhook-specific Fields
Field Name | Content | Type |
---|---|---|
type | newUserIsCreated |
string |
dateOfSignUp | Sign Up Date Time | string |
signUpSource | adminPublicAPI - user was created via public API (this case also includes when users are created automatically when being registered for an event via API) |
|
adminDashboard - user was created via the Gradual Dashboard (this case also includes when users are created when being registered for an event via the dashboard) |
||
adminImport - user was created via a bulk import (this case includes all import methods including users created from bulk event registrations and bulk speaker upload) |
||
selfSignUp - user self-created their account on Gradual (this case also includes when users are created when registering for an event) |
||
systemAutoCreate - user was created by backfill scripts, or by creating a new tenant with the default admin user option |
||
integrationHubspot user was created by hubspot inbound webhook(Jun) |
string |
User Info Fields
Field Name | Content | Type |
---|---|---|
userId | User ID | string |
userEmail | string | |
userFirstName | First Name | string |
userLastName | Last Name | string |
userCompany | Company Name | string |
userTitle | Job Title | string |
userLinkedIn | LinkedIn URL | string |
userAvatarUrl | Avatar URL | string |
userLocation | Location | string |
memberType | Membership Type | string |
approvalStatus | Approved / Pending | string |
externalId | unique id of user’s external profile (if applicable) | string |
externalDisplayId | name or username of external profile (if applicable) | string |
externalProfileUrl | URL of external profile (if applicable) | string |
Tracking Data fields
Field Name | Content | Type |
---|---|---|
utmSource | UTM Source | string |
utmMedium | UTM Medium | string |
utmCampaign | UTM Campaign | string |
utmContent | UTM Content | string |
utmTerm | UTM Term | string |
referUrl | Referrer URL | string |
Webhook-specific Fields
Field Name | Content | Type |
---|---|---|
type | userRegistersForEvent |
string |
dateOfRegistration | Registration Date Time | string |
eventQuestions | User Answers to Event Questions | object |
(dynamic based on event setup) |
Event Info Fields
Field Name | Content | Type |
---|---|---|
eventName | Event Name | string |
eventslug | Event Slug | string |
eventUrl | Event Gradual URL | string |
Referral Data Fields
Field Name | Content | Type |
---|---|---|
referringCode | Referring Code | string |
referringUserId | Referring User ID | string |
referringUserEmail | Referring User Email | string |
referringUserFirstName | Referring User First Name | string |
referringUserLastName | Referring User Last Name | string |
referringUserTitle | Referring User Job Title | string |
referringUserCompany | Referring User Company | string |