Create webhooks

Webhooks are notifications that the AppDirect platform can send to specified URLs when certain events occur in the system. You can configure webhooks for the events you want to keep track of, so they are sent to a system where you can collect and analyze the data.

For example, you can create webhooks to send notifications when users are created, when products are modified, when subscriptions are canceled, and so on. These event notifications can be sent to an external customer relationship management (CRM) system so you can track sales, product orders, and subscriptions. Similarly, you can transmit relevant information to enterprise resource planning (ERP) systems, billing systems, back ends, and other systems you use for business analysis.

The AppDirect platform sends notifications by HTTP POST request, and the notifications themselves are in JSON format. For a complete discussion, see Webhooks.

To create a webhook

📝 Note: If the AppDirect logo appears in the upper-left corner of the page, when Manage > Marketplace appears in this topic, click the grid icon > Switch to | Store, instead.

1. Go to Manage > Marketplace > Settings > INTEGRATION | Webhooks.

2. Click Add Webhook.

3. Enter the URL of the location to which the notifications will be sent. Ensure that you specify HTTPS instead of HTTP.

4. Select one of the following resources from the drop-down list to send the notification to the URL.

   Resource (notification type)	Supported actions	Notes
   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 Registrant	Added	Occurs 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

5. Select one or more of the following Action checkboxes:

   • Added
   • Changed
   • Deleted

6. Select one of the following authentication types:

   • None
   • Token
   • OAuth2 (Resource Owner Password)
   • OAuth2 (Client Credentials)

7. Click Save Webhook. A message confirms that the webhook was created, and it appears in the Webhooks table.