Summary

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.

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

New User Login

When a user logs in to the platform for the first time

• Example Payload
• Payload Fields:

  • Webhook-specific Fields

    Field Name	Content	Type
    type	newUserLogin	string
    dateOfLogin	Log In Date Time	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

User Cancels Event Registration

(When a user cancels their event registration

New Guest Check-In

(Completed when a guest checks in for an event)

New Event Invite Request

(When a user requests to join an invite only event)

• Payload