User webhook

This webhook is sending data each time an account is updated.

As project data contain personal data, be sure to respect processing and storage regulations like GDPR (General Data Protection Regulation), CCPA (California Consumer Privacy Act), or any other applicable ones where you export such data.

Attributes

apiKey string
Added to the data if defined
id string
Unique identifier of the user.
firstName string
First name of the user.
lastName string
Last name of the user.
username string
Username of the user.
email string
Email address of the user.
role string
Role of the user.
emailStatus string
Confirmation status of user's email address.
phone string
Formated phone number and code of the user.
job string
Job title of the user.
company string
Company name the user is working at.
country string
Country where the user lives.
countryCode string
Alpha-2 ISO code of the country where the user lives.
city string
City where the user lives.
location array of string
Other location information about the user.
tags array of string
List of the user tags.
description string
Description of the user.
status string
Professional situation of the user, can be one of the following values:
  • Employed
  • Looking for a job
  • Student
  • Freelancer
  • Working for a startup
website string
Website URL of the user.
source string
Origin source of user creation, can be one of the following values:
  • invitation: user have been invited by an admin
  • self-registration: user registered themselves
  • import: user have been imported into the platform
  • external-api: user have been added using the external API of the platform
invitationStatus string
Current invitation status of the user, can be one of the following values:
  • Not sent: no invitation or reminder has been sent
  • Invited: invitation or reminder has been sent
  • Signed-up: user has ended their registration
registrationStatus string
Current registration status of the user,can be one of the following values:
  • Not started: user account exist but is empty
  • In progress: user started their registration but stoped at some point
  • Finished: user finished their registration
registrationDate string
Date when the user finished the user registration.
sso string
SSO used by the user to create their account, is set to BMA when none have been used.
ssoExternalID string
ID of user account on the SSO used to create their account.
projects array of string
List of projects the user is a member of.
customFields object
Answers given by the user to custom questions asked during the registration.
hiddenFields object
List of URL parameters the user had when registering. Only the ones defined in platform Back Office can be captured.

Sample data sent by the webhook (JSON) 

{
  "apiKey": "{API_KEY}"
  "id": "6246c1bfe02d2c7d418c96e4",
  "username": "johndoe",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@domain.com",
  "role": "attendee",
  "emailStatus": "confirmed",
  "phone": "+1 555 555 1234",
  "job": "Developer",
  "company": "Test Inc.",
  "country": "United States of America",
  "countryCode": "US",
  "city": "San Francisco",
  "location": ["San Francisco", "Nampa"],
  "tags": ["Organizer", "Designer"],
  "description": "Lorem ipsum dolor sit amet.",
  "status": "Freelancer",
  "website": "https://sample-domain.com",
  "source": "self-registration",
  "registrationStatus": "Invited",
  "registrationDate": 2022-04-15T15:58:08.779+00:00,
  "sso": "BMA",
  "ssoExternalID": "BMA",
  "projects": ["Project One", "Project Two"],
  "customFields": {
    "6246c1bfe02d2c7d418c96e4": ["Choice #1", "Choice #2"],
    "6246c1dee02d2c7d418c96ee": ["Lorem ipsum dolor sit amet."]
  },
  "hiddenFields": {},
}