> ## Documentation Index
> Fetch the complete documentation index at: https://docs.m1amdocs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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

1. Navigate to **Platform Settings** > **Webhooks**.

2. 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.

3. Specify an endpoint URL.

4. 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.

5. 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**.

6. When you are done, click **Create Webhook**.

   The webhook is created and a confirmation message appears.

* **[Webhook Details](m_webhooksManage#webhook-details)**

**Parent topic:**[Webhooks](m_webhooksAbout)

## 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](https://www.amdocs.com). | Required |
| **Events** | Select the events to receive notifications for.You can select one or more of the following: - Add subscription - Add multiple subscriptions - Update subscription - Delete subscription - Update subscription metadata - Pause subscription - Resume subscription | 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](m_webhooksManage) | | |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.