Manage Webhooks

A webhook is a way for Partner Ecosystem Management to provide your system with real-time data about events. Note: The required webhooks vary depending on your deployment. For example, in a deployment that includes Commerce Engine and Storefront Experience, the following webhooks are required:

Partner subscription events (all)
Subscription events (all)

Within Platform Settings > Webhooks, you can:

Create webhooks
Edit webhooks
Delete webhooks

Navigate to Platform Settings > Webhooks.
Select what you would like to do from the following options:
- To create a webhook, click New Webhook. The New Webhook box appears.
- To edit an existing webhook, select the menu at the end of the row of the webhook. Select Edit. The edit page for the webhook appears.
- To delete an existing webhook, select the menu at the end of the row of the webhook. Select Delete. A box appears confirming your choice. Confirm the deletion.
Specify an endpoint URL.
Select the events to subscribe to. Note: If you’re using Commerce Engine and Storefront Experience, you must subscribe to all Partner subscription and subscription events to ensure full functionality and real-time updates.
Secure the webhook by setting credentials. This step is recommended for security purposes.
- Username and password: After selecting this option, provide the username and password. Confirm the password a second time and click Set Credentials.
- API key: After selecting this option, enter X_API_KEY in the Header field and enter the API key into the API Key field. Click Set Credentials.
- OAuth2: After selecting this option, provide the Access Token and click Set Credentials.
When you are done, click Create Webhook. The webhook is created and a confirmation message appears.

Webhook Details

Parent topic:Webhooks

Webhook Details

General Information

Field Name	Guidance	Required or Optional
Endpoint URL	Enter a valid and secure (HTTPS) URL for the endpoint. This is where the resource will exist and where the Partner Ecosystem Management APIs will send notifications. An example of a valid URL is https://www.amdocs.com.	Required
Events	Select the events to receive notifications for. You can select any of the following Partner subscription events: - Partner subscription created - Partner subscription activated (redeemed) - Partner subscription canceled - Partner provisioning failed - Partner subscription modified - Partner subscription paused - Partner subscription resumed You can select any of the following subscription events: - Subscription created - Subscription activated - Subscription canceled - Subscription modified - Subscription stopped - Subscription paused - Subscription resumed - Subscription trial ending reminder You can select the following external catalog event: - Published product specification	Required

Set Credentials

Model	Guidance	Required or Optional
Credentials	You can secure the webhook event data by setting credentials. We recommend that you add credentials, but they are not required. To set credentials, you need to first obtain them for your system. You must choose one of the following options: - No Credentials - Username and password - API key - OAuth2 access token	Required
Parent topic:Manage Webhooks

Home

Introduction

For Merchants

For Resellers

Partner Ecosystem Management

Commerce Engine

Storefront Experience

APIs

Webhook Details

General Information

Set Credentials

​Webhook Details

​General Information

​Set Credentials

Webhook Details

General Information

Set Credentials