Event attributes

AppDirect may pass several attributes as part of the request (JSON or XML) when it sends an event notification request to a vendor. The table contains all the possible attributes.

Supported request attributes

Request Field	Format	Required	Description
type	String Enum	Yes	The type of event triggered in the AppDirect marketplace. Can be SUBSCRIPTION_ORDER, SUBSCRIPTION_CHANGE, SUBSCRIPTION_CANCEL, SUBSCRIPTION_NOTICE, USER_ASSIGNMENT, or USER_UNASSIGNMENT.
marketplace	Object	Yes	Information about the partner marketplace.
marketplace.partner	String	Yes	The name of the marketplace. It defaults to APPDIRECT.
marketplace.baseUrl	String	Yes	The root URL for the partner marketplace.
applicationUuid	String	No	The unique identifier for the application.
flag	String Enum	No	Flag indicating how the event is used, may be STATELESS or DEVELOPMENT.
returnUrl	String	No	An optional redirect URL. This attribute is only populated when interactive endpoints are used.
creator	Object	No	The identity of the admin creating the event. Note that this will be the original purchaser of the application for SUBSCRIPTION_ORDER, but may be other users for the other event types.
creator.email	String	Yes	Email address for the creator.
creator.firstName	String	No	First name of the creator.
creator.language	String	No	Default language for the creator.
creator.lastName	Object	No	Last name of the creator.
creator.locale	String	No	Default locale for the creator.
creator.openId	String	No	The openId for the creator.
creator.uuid	String	No	Unique user identifier for the creator.
creator.address	Object	No	The creator's address
address.city	String	Yes, if address specified	Creator address city
address.country	String	Yes, if address specified	Creator address country
address.state	String	No	Creator address state
address.street1	String	Yes, if address specified	Creator street address line 1
address.street2	String	No	Creator street address line 2
address.zip	String	Yes, if address specified	Creator address zip code
creator.attributes	Array	No	Optional attributes about the creator.
payload
payload.user	Object	Yes, for USER_ASSIGNMENT, USER_UNASSIGNMENT, and USER_UDPATED events	The affected user; may or may not be the same as the creator.
user.email	String	Yes	Email address for the user.
user.firstName	String	No	First name of the user.
user.language	String	No	Default language for the user.
user.lastName	Object	No	Last name of the user.
user.locale	String	No	Default locale for the user.
user.openId	String	No	The openId for the user.
user.uuid	String	No	Unique user identifier for the user.
user.attributes	Array	No	Optional attributes about the user.
payload.user.address	Object	No	The user's address
address.city	String	Yes, if address specified	User address city
address.country	String	Yes, if address specified	User address country
address.state	String	No	User address state
address.street1	String	Yes, if address specified	User street address line 1
address.street2	String	No	User street address line 2
address.zip	String	Yes, if address specified	User address zip code
payload.account	Object	Yes, if account has been created.	The account associated with the event, except for SUBSCRIPTION_ORDER (when account is created).
accountIdentifier	String	Yes, if account has been created.	The unique account identifier.
status	String	Yes, if account has been created.	The current account status. Can be INITIALIZED, FAILED, FREE_TRIAL, FREE_TRIAL_EXPIRED, ACTIVE, SUSPENDED, or CANCELLED. The account will be in the INITIALIZED state until the Vendor provides a result to AppDirect indicating whether the account was successfully created or not. When success is true, for instance, the account will be put into an ACTIVE or FREE_TRIAL state as appropriate. When success is false, the account will be put into a FAILED state.
payload.company	Object	Yes, for SUBSCRIPTION_ORDER	Information about the company associated with the event.
company.uuid	String	Yes	The unique identifier for the company.
company.externalId	String	No	The external identifier for the company.
company.name	String	Yes	The name of the company.
company.email	String	No	The email associated with the company.
company.phoneNumber	String	Yes	The phone number associated with the company.
company.website	String	Yes	The company's website.
company.country	String	No	The company's country.
ParentAccountIdentifier	String	Yes, for addon-related events	The unique account identifier account associated with the addon. You may see this field in other events but it may not have a value.
payload.order	Object	Yes, for SUBSCRIPTION_ORDER and SUBSCRIPTION_CHANGE	Part of payload, SUBSCRIPTION_ORDER and SUBSCRIPTION_CHANGE
order.editionCode	String	Yes	The code for the edition associated with the subscription event.
order.AddonOfferingCode	String	No	The code for the addon offering associated with the subscription event, if there is an addon.
order.pricingDuration	String	Yes	The pricing duration for the edition associated with the subscription event.
order.discountCode	String	No	The optional vendor discount code created on the marketplace.
subscriptionId	String	No	A unique identifier for a subscription in the marketplace. It is an optional attribute for USER_ASSIGNMENT and USER_UNASSIGNMENT.
payload.AddonInstance	Object	Yes, for addon-related events	Information about the addon.
AddonInstance.id	String	Yes, for addon-related events	The identifier for the addon instance.
payload.AddonBinding	Object	Yes, for addon-related events	Information about the addon binding.
AddonBinding.id	String	Yes, for addon-related events	The identifier for the addon binding.
payload.notice	Object	Yes, for SUBSCRIPTION_NOTICE only.	Information about the notice.
notice.type	String Enum	Yes	Type of notice; can be REACTIVATED, DEACTIVATED, or CLOSED
notice.message	String	No	A message containing additional information about the notice.
payload.configuration	Array	Yes, for SUBSCRIPTION_ORDER and SUBSCRIPTION_CHANGE	The configuration from the subscription's purchase order.

This table summarizes the attributes expected in the JSON or XML response.

Response attributes

Response Parameter	Description
accountIdentifier	Unique account identifier for the customer on the vendor platform. Only required in the response to a Subscription Order Event.
userIdentifier	An optional unique user identifier for the user on the vendor platform.
errorCode	A mandatory error code as described in Event error codes when success is false.
message	An optional message string to use in conjunction with the errorCode.
success	A required boolean value - true when success, false when error.