Skip to main content
The UserCreate event fires whenever a new user is provisioned in the HoopAI platform. It delivers the full user profile including identity, contact details, assigned role, and granular feature permissions. Use this event to synchronize user records to external systems, trigger onboarding workflows, or audit access changes.

​
Payload

FieldTypeDescription
typestringAlways "UserCreate"
idstringUnique identifier for the newly created user
firstNamestringUser’s first name
lastNamestringUser’s last name
emailstringUser’s email address
phonestringUser’s phone number in E.164 format
extensionstringTelephony extension assigned to the user
locationIdstringAccount ID the user belongs to; present for location-level users
companyIdstringCompany ID the user belongs to; present for admin-level users
rolestringAssigned role, e.g. "user" or "admin"
permissionsobjectMap of boolean flags controlling the user’s feature access (e.g., campaigns, payments, workflows)
locationsarrayList of location IDs the user has access to

​
Example payload

{
  "type": "UserCreate",
  "id": "ve9EPM428h8vShlRW1KT",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phone": "+19509597501",
  "extension": "101",
  "locationId": "otg8dTQqGLh3Q6iQI55w",
  "role": "user",
  "permissions": {
    "campaignsEnabled": true,
    "appointmentsEnabled": true,
    "workflowsEnabled": true,
    "paymentsEnabled": false
  }
}
  • Accounts API — manage and retrieve account details
  • Users API — list, create, and update users programmatically
Last modified on March 5, 2026