Create company-level webhooks

Developers who are also their company’s Company Administrator can set webhooks at a company level to send notifications when events associated with that company’s resources change. For example, if you create a company-level webhook specifying the Membership resource, a notification is sent to the associated URL when a new person becomes a member of that company.

Webhooks can also be set at the marketplace level by Marketplace Managers. Marketplace-level webhooks send notifications when events associated with the entire marketplace’s resources change. For more information about marketplace-level webhooks, see Use webhooks.

To create company-level webhooks,

1. Go to Manage > Billing and Distribution > Webhooks. The Webhooks page opens and displays any existing company-level webhooks.
2. Click Add Webhook.
3. Enter the URL to which the notifications is sent.
4. Select one of the following resources from the drop-down list to send the notification to the URL.
   • App Assignment—Sends a notification when an application is assigned to a user, unassigned from a user, or an assignment is changed as follows:
     • An application assignment is successfully provisioned.
     • An application assignment fails.
     • An application unassignment fails.
     • An application assignment changes from one pending state to another. For example, when a status changes from PENDING_USER_ACTIVATION to PENDING_REMOTE_CREATION.
   • Catalog Product—Sends a notification when a a catalog product (including bundles) is added, changed, or deleted on the Edit Marketplace Settings page (at 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—Sends a notification when a company is created, updated, or deleted.
   • Invoice—Sends a notification when an invoice is added, changed, or deleted.
   • Membership—Sends a notification when a company membership is created, updated, or deleted. A company membership is the relationship between a marketplace user and a company.
   • Order—Sends a notification when an order is created, updated, or deleted. An order is the selected product and edition details 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—Sends a notification when a payment instrument is created or updated. Payment instruments include credit card information, billing address, and any other account information used for billing.
   • Staging Product—Sends a notification when a staging product is added, changed, or deleted.
   • Subscription—Sends a notification when a subscription is created, updated, or deleted. Subscriptions are the relationship between a company and a product. They include information about the company, user, and active order.
   • User—Sends a notification when a user is created, updated, or deleted.
5. Select one or more of the following Action checkboxes:
   • Added—Triggers a notification when the selected resource is added to the company.
   • Deleted—Triggers a notification when the selected resource is deleted from the company.
   • Changed—Triggers a notification when the selected resource changes for the company.
6. Select one of the following authentication types to help ensure the notification is genuine or None:
   • Token—Enter the token you obtained.
   • OAuth2 (OAuth2 authentication for webhooks only supports the password grant type)—Enter the corresponding information in the following fields:
     • Access Token URI
     • Client ID
     • Client Secret
     • Username
     • Password
7. Click Save Webhook. A message confirms that the webhook was created, and it appears in the Webhooks table.