Summary

New customers are asking for additional integrations to their related systems. Suggesting we implement outbound webhooks for the common platform related events that would allow them to use code or no-code tools (E.g. Zapier, Integromat, etc) to build automations.

Operational and scaling benefit is that it would allow us to avoid custom one-off integrations with certain platforms.

Alternatively we could explore making our API documentation available and build an accessible API allowing external teams to integrate to Gradual, but based on current customers, the webhook would be more applicable to more customers.

Outbound Webhook Events

• New User Is Created - A new user is created by any method (user does not have to log in and begin a session)
  • Example Payload
  • Payload Fields:

    • 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	Email	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

    • 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

• User Registers for Event (Completed when logged-in user successfully registers for an event)
  • Payload Fields:

    • 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

• User Cancels Event Registration (When a user cancels their event registration
  • Payload

    • Webhook-specific Fields:

      Field Name	Content	Type
      type	userCancelsEventRegistration	string
      dateOfCancellation	Cancellation Date Time	string

• User Completes Onboarding
  • Payload Fields

    • Webhook-specific Fields

      Field Name	Content	Type
      type	userCompletesOnboarding	string
      dateOfOnboardingComplete	Onboarding Complete Date Time	string
      onboardingQuestions	Tenant Onboarding Questions	object
      (tenant-specific)

• User Checks In To Event - When a user checks in to an in-person event
• User Attends an Event - when a user attends a virtual event
• User Un-checks in to an event - when a user un-checks in to an in-person event
• User Refers Event Registrant - sent when another user uses the contact’s URL to register for an event
• Referral Registrant Cancels Event Registration - sent when another user who used the contact’s URL to register for an event cancels their registration
• User Updates Profile
• User Approval Status Changed
• User Type Changed - sent when the Membership Type of a user is updated