User webhook payload

The resource:url for a User webhook payload uses this basic format:

https://marketplace_url/api/account/v1/users/user_id?isExternalId=value

Here marketplace_url is the main URL for the marketplace (for example, mycompany.byappdirect.com ), and user_id is the marketplace identifier for the user (for example, c4755ba5-d0f0-4ed3-89c5-1581793cb0ed ).

The user_id may be a universally unique identifier, or it may be an identifier that is used for this user on an external system, as determined by your marketplace settings. For more information, contact your AppDirect technical representative.

When a User:Added or User:Changed webhook is triggered, the content section of the payload includes the following attributes:

Attribute	Type	Description
id	String	The primary identifier used to identify the user. Depending on the marketplace settings, this id matches either the externalId or the internalId. For more information, contact your AppDirect technical representative.
openId	String	A URL to an XML text document that contains the specifications for OpenID 2.0.
email	String	The primary email address for the user.
username	String	The username for the user. If not specified, this defaults to the user's email address.
firstName	String	The first or given name of the user.
lastName	String	The last or family name of the user.
language	String	A two-character string representing the language associated with the user and company. Must be a recognized ISO ALPHA-2 standard language code. For example, 'en'.
locale	String	The user locale in the standard ISO 639-1 language code + ISO 3166-1 country code format. For example: 'en_US', 'fr_CA', and so on.
password	String	Deprecated (the value is always "null").
profilePic	String	URL to a graphic to be used as the user's profile picture. Equivalent to the V2 "picture".
deleted	Boolean	Deprecated (the value is always "false").
status	Enum	Whether this user is ACTIVE or INACTIVE. Users are INACTIVE by default until they accept an invitation to join a company, at which point the user becomes ACTIVE.
contact	Object	An object that stores information about different methods to contact the user.
contact:phoneNumber	String	Primary phone number for the user.
contact:ims	String	An Instant Messaging Service identifier associated with the user. Deprecated (the value is always "null").
contact:homePhone	String	The user's home phone number.
contact:mobilePhone	String	The user's mobile phone number.
contact:address	Object	An object that stores information about a billing address for a payment method associated with the user.
{...}:address:street1	String	The first part of the street address.
{...}:address:street2	String	An optional second line for the street address.
{...}:address:city	String	The city in which the billing address is located.
{...}:address:state	String	The state or province in which the billing address is located.
{...}:address:zip	String	The ZIP code or postal code.
{...}:address:country	String	The country in which the user is located.
registrationCode	String	Deprecated (the value is always "null").
creationDate	Number	The time and date when this user was created on the marketplace, represented in UNIX Epoch milliseconds.
lastSuccessfulLogin	Number	The time and date when the user most recently logged in to the marketplace, as represented in UNIX Epoch milliseconds.
title	Enum	An honorific by which the user may be addressed. Must be one of MR, MS, or COMPANY.
activationUrl	String	Deprecated (the value is always "null").
internalId	String	The universally unique identifier (uuid) for the user on the marketplace. Equivalent to the V2 "uuid".
externalId	String	A unique identifier that an external identity provider (Idp) or other external system uses for this user. This identifier may be in any format.
idpUuid	String	A universally unique identifier that an external identity provider (Idp) or other external system uses for this user. This identifier must be a uuid.
customAttributes	Object	A list of user custom attributes that have been defined on the marketplace. For users, these are all in the format customAttributes.x, where x is the name of the attribute.
memberships	Object	A list of memberships that the user holds. Each user must be a member of at least one company, and may belong to several companies. Each membership includes the fields detailed below (enabled, company, roles, metadata).
{...}:enabled	Boolean	Whether the membership is enabled.
{...}:company	Object	Company of which this user is a member. This section includes the full company payload for a company webhook. See Company webhook payload.
{...}:roles	Object	An array of roles that the user holds within the company, which define what the user is permitted to do. Possible roles include: CHANNEL_ADMIN (Marketplace Manager) CHANNEL_PRODUCT_SUPPORT (Product Support) SALES_SUPPORT (Sales Support) RESELLER_MANAGER (Reseller Manager) RESELLER (Reseller) CHANNEL_SUPPORT (Customer Support) SYS_ADMIN (Company Administrator) BILLING_ADMIN (Billing Administrator) DEVELOPER (Developer) USER (User) For more information about roles, see the online help about how to manage roles.
{...}:metadata	Object	A list of metadata parameters that apply to the user. Each attribute appears as a key:value pair.
{...}:metadata:employeeId	String	A unique identifier or code that identifies the user within the company.
resellerUserCompany Associations [ ]	Object	A list of companies in which this user is a reseller (has the RESELLER role).
salesAgent	Object	Information about a linked Reseller user who is empowered to make purchases and assignments for this user.
salesAgent:id	String	The universally unique identifier (uuid) that identifies the salesAgent user.
salesAgent:href	String	A URL that can be used to retrieve user information about the salesAgent user.