Commerce Panel → Company → Settings → Webhook
On Fynd Commerce, you can create and configure webhooks to receive real-time notifications when specific events occur. The Webhooks list page displays all configured webhooks with the following details for each entry:
- Name: The webhook name.
- Events: The event categories subscribed to (e.g., collection, product-size, location, order).
- Modified by: The user who last modified the webhook.
- Modified on: The date and time of the last modification.
- Status: Indicates whether the webhook is ACTIVE or INACTIVE.
The page provides two action buttons in the top-right corner:
- Create Webhook: Opens the webhook creation form to configure a new webhook.
- Reports: Opens the Webhook Report page where you can view delivery logs and debug webhook failures across all webhooks.
Each webhook entry has a three-dot menu (⋮) on the right with the following options:
- View Report: Opens the report filtered to this specific webhook, showing its delivery history and response details.
- Copy: Creates a duplicate of the webhook configuration, which you can then modify as needed.
Prerequisite: You must have a webhook URL that is configured to receive an HTTP POST payload from Fynd Commerce.
- Click Create Webhook to open the configuration form. The form is divided into two parts: Details and Events.
Name (required): Enter a name for the webhook (maximum 30 characters). This name is used to identify the webhook in the list and in reports.
Webhook URL (required): Enter the target endpoint URL where Fynd Commerce will send the HTTP POST request containing event data (maximum 2048 characters).
If you have a private server, make sure you whitelist the IP address. Know more about webhook IP whitelisting.
Alert Email (required): Enter the email address on which you wish to receive alerts in case the webhook delivery fails. This field is pre-filled with the logged-in user's email but can be changed.
Custom Headers (optional): Enable this checkbox to send custom headers along with your webhook request. When enabled, you can add one or more key-value header pairs that will be included in every HTTP POST request sent to your webhook URL. This is useful for passing additional metadata or routing information to your server.
Authentication (optional): Enable this checkbox to authenticate the webhook URL with a secret password. When enabled, enter a secret that will be included in the webhook =payload for signature verification. This is useful when you want to validate a webhook for the authenticity of its source (read Webhook Validation). Ensure that you do not reveal or expose the secret publicly.
Select the events you wish to receive. Events are organised into three categories: Company, Sales Channel, and Global. Each event has a version selector (e.g., V1, V2) and an Event Types dropdown to choose specific actions (such as create, update, delete) within that event.
You may click the external link icon next to any event name to view the expected payload schema for that event.
Select the company-level events you wish to receive. These events are triggered by changes at the company level and are not tied to a specific sales channel. Available company events include:
- Article
- Brand
- Company
- Courier Partner
- Custom Field Definition
- Custom Fields
- Custom Object Definition
- Custom Objects
For each event, select the version from the dropdown and choose one or more event types (e.g., create, update, delete) from the Select Event Types dropdown.
Select channels and events you wish to receive for specific sales channels. First, choose one or more sales channels from the Sales Channels dropdown, then select the events and their types. Available sales channel events include:
- Address
- Article
- Available Pages
- Cart
- Cart Price Adjustment
- Collection
- Configuration
- Coupon
And additional events visible by scrolling further in the form.
Click Events are a subset of Sales Channel events that track customer interactions on your storefront. These are useful for analytics, personalisation, and behavioural tracking. Available click events include:
- Add To Cart
- Delivery Promise
- Location Details
- Order Checkedout
- Order Checkout
- Order Complete
- Product Listing
- Product Price
- Product Search
- Product View
- Product Wishlist Add
- Product Wishlist Remove
- Remove From Cart
- User Login
- User Logout
Select global events that apply across the platform and are not scoped to a specific company or sales channel. Available global events include:
- Category
- Department
Test the webhook to check whether it works correctly (read more in Webhook Testing).
Click Save.
Turn ON the webhook from the list page.
You've successfully configured a webhook.
The Webhook Report page provides a detailed log of all webhook delivery attempts. Access it by clicking the Reports button on the Webhooks list page, or by selecting View Report from the three-dot menu on a specific webhook.
The page has two tabs:
- Reports: Displays the delivery log with filters and a searchable table.
- History: Displays historical webhook activity.
Use the following filters to narrow down the report:
- Search: Search by any keyword or value in the payload.
- Status: Filter by delivery status (e.g., All, Success, Failed).
- Date Range: Filter by time period (e.g., Last 24 hours).
- Event: Filter by a specific event type from the dropdown.
- Subscriber Name: Filter by the webhook subscriber name.
- Webhook Type: Filter by webhook type (e.g., REST).
The report table displays the following columns for each delivery attempt:
- Name: The webhook or subscriber name.
- Event: The event that triggered the delivery (e.g., article.update.v1.company, shipment.update.v1.application, order.placed.v1.application).
- Webhook Type: The type of webhook (e.g., REST).
- Response Code: The HTTP response code returned by your endpoint (e.g., 200, 401, 404).
- Response/Error Message: A summary of the response or error (e.g., Not Found, Unauthorized).
- Response Time (ms): The time taken for your endpoint to respond, in milliseconds.
- Processed On: The date and time the delivery was attempted.
- Request/Payload: A link to view the full request payload sent to your endpoint.
This report is useful for debugging failed deliveries, verifying that your endpoint is receiving payloads correctly, and monitoring response times.
Once you create a webhook, it will appear in the list of webhooks as shown in fig. 1. You can click on an existing webhook and edit its details.
At any point in time, you can edit an existing webhook to do the following:
- Change the name
- Enter a new webhook URL
- Change the secret used for authentication
- Enter a new alert email
- Add or remove event types
Click Update once you're done editing the details.
In case you wish to cancel a webhook subscription, use the toggle button to turn OFF the webhook. You'll no longer receive notifications for the subscribed event.
You can use the same toggle button to turn ON the webhook and re-subscribe to the event.