The user
object is included in the Create and Update User endpoints and is included in some webhook callbacks when referring to driver and dispatch events.
Request Data
Below is a list of parameters you can send as part of the user
object, for example, when sending the Create User request.
Read our Data Formatting article for more details about how different parameter types, such as datetime, are formatted and used in Bringg.
Field | Description |
---|---|
admin boolean | Indicates if the user has administrative privileges. |
dispatcher boolean | Indicates if the user is a dispatcher. |
company_id string | Bringg's ID for the group of users within a team. See Get Companies. |
company_external_id string | Your external system's ID for the group of users within a team. See Get Companies. |
driver boolean | Indicates if the user is a driver. |
email string | The user's email. |
emergency_contact_name string | Name of emergency contact (for use with the Rapid SOS application). |
emergency_contact_phone string | Phone number of emergency contact (for use with the Rapid SOS application). |
external_id string | The unique identifier for the user in your external system. |
external_team_ids array of strings | An array of your external system's IDs for the teams to which the user belongs. |
home_address string | The address of the user's "home" base, usually a warehouse or store location. |
home_lat number | The latitude of the user's "home" base. |
home_lng number | The longitude of the user's "home" base. |
language string | The user's preferred language. |
name string | The user's name. |
password string | The user's password, which should be changed after initial login. |
phone string | The user's phone number. |
privilege_id integer | The ID of the dispatcher or driver's Privileges group, which associates a dispatcher user with a set of authorization flags. |
private_vehicle boolean | Indicates whether the driver uses their own vehicle to determine if mileage should be compensated. |
skills array of strings | Driver capabilities, such as installation . Bringg matches these skills with the required_skills parameter to automatically assign routes to the most suitable driver based on their capabilities. |
team_ids array of strings | The IDs of the teams to which the user belongs. |
user_type_external_id string | The driver user role ID in your external systems. Can be used instead of user_type_id . |
user_type_id integer | The ID of the user type within Bringg. |
Response & Webhook Data
Below is a list of the data returned in webhooks and responses to your API requests. The inclusion of specific parameters may depend on your use case, your API request, and the webhook fields you have subscribed to.
Parameter | Description |
---|---|
team_external_ids array of strings | An array of your external system's IDs for the teams to which the user belongs. |
private_vehicle boolean | Indicates whether the driver uses their own vehicle to determine if mileage should be compensated. |
skills array of strings | Driver capabilities, such as installation . Bringg matches these skills with the required_skills parameter to automatically assign routes to the most suitable driver based on their capabilities. |
access_token string | The access token for the user. |
authentication_token string | The authentication token for the user. |
beta boolean | Indicates if the user is part of a beta program. |
created_at datetime | The timestamp when the user was created. |
email string | The user's email. |
email_hash string | The hash of the user's email. |
id integer | The unique identifier of the user. |
job_description string | The user's job description. |
lat number | The latitude of the user's last reported location. |
lng number | The longitude of the user's last reported location. |
name string | The user's name. |
password_hash string | The hash of the user's password. |
profile_image string | The URL of the user's profile image. |
push_token string | The push token for the user's device. |