Skip to main content

Webhook resources, actions, and events

Webhooks send notifications when AppDirect system events occur. Events are composed of resources (subscriptions, app assignments, users, and so on) and actions (ADDED, CHANGED, or REMOVED). For example:

  • subscription.added occurs when a subscription is created for a customer.
  • subscription.changed occurs when a customer's existing subscription is changed in some way.
  • subscription.removed occurs that a customer's subscription ends or is canceled.

Resource list

Webhook notifications can be sent for the following resource types and associated actions. Some resources only support one or two actions, because not all actions are relevant to every resource. For example, the Reseller Registrant resource only supports the Added action because it is not possible to change or remove a "registrant."

Resource (notification type)Supported actionsNotes
App Assignment

Added

Changed

Deleted

Occurs when an application is assigned to a user, unassigned from a user, or changed as follows:

  • An application assignment is successfully provisioned.
  • An application assignment fails.
  • An application unassignment fails.
  • An application assignment changes from one pending status to another, for example, when a status changes from PENDING_USER_ACTIVATION to PENDING_REMOTE_CREATION.
Catalog Product

Added

Changed

Deleted

Sends a notification when a Marketplace Manager adds, changes, or deletes a catalog product (including bundles) in the Edit Marketplace Settings dialog (at Manage > Marketplace > Product > Catalog | Product Catalog > gear icon   > Edit Marketplace Settings). All modifications performed in the Edit Marketplace Settings page trigger a CHANGED event except the Visible on Marketplace checkbox:

  • Setting an application as visible by selecting the checkbox triggers an ADDED event.
  • Setting an application as hidden by clearing the checkbox triggers a REMOVED event.

Company

Added

Changed

Deleted

 
Discount

Added

Changed

Deleted

A notification is not sent when a customer applies a discount code to a purchase.

Invoice

Added

Changed

Deleted

 
Membership

Added

Changed

Deleted

A membership is the relationship between a user and a company. A user must have a membership defined to be associated with a company.
Order

Added

Changed

Deleted

An order is the selected product and edition included in a subscription. An update event is triggered when one of the following states changes:

  • INITIALIZED
  • PENDING_USER_APPROVAL
  • PENDING_ASYNCHRONOUS_CREATION
  • FREE_TRIAL
  • ACTIVE
  • ONE_TIME
  • SUSPENDED
  • FREE_TRIAL_EXPIRED
  • FREE_TRIAL_CANCELLED
  • CANCELLED
Payment Instrument

Added

Changed

Payment instruments include credit card information and any information used for billing.
Platforms

Added

Changed

Deleted

 
Quote

Added

Changed

Deleted

 
Reseller RegistrantAddedOccurs when a reseller is registered on the marketplace. It is not possible to change or remove a "registrant."

Lead

Added

Changed

Deleted

 
Staging Product

Added

Changed

 
Subscription

Added

Changed

Deleted

A subscription is the relationship between a company and a product. It includes information about the company, user, and active order.

User

Added

Changed

Deleted

 

Was this page helpful?