Release notes

These release notes describe the latest version of Adobe Commerce Webhooks.

Version 1.5.1

Release date

July 10, 2024

• Improved caching of webhook responses during single request.

• Fixed a possible vulnerability issue with showing the public key in the Admin UI configuration page.

Version 1.5.0

Release date

May 20, 2024

Changes

The Admin configuration UI for webhooks was removed as part of a security risk mitigation. Webhooks provide developer-oriented functionality and the Admin UI gave an unprecedented amount of access to admins, which could be inappropriate in some cases. All other webhooks functionality is still supported.

Upgrading to the latest version could impact existing webhooks. If you previously had webhooks that were created in the Admin UI, you must recreate them in an XML file.

Version 1.4.0

Release date

May 15, 2024

Enhancements

• Added the ability to enable digital signatures for webhooks.

• Updated the list of disallowed webhooks.

Version 1.3.1

Release date

April 25, 2024

Enhancements

• Added the ability to sanitize sensitive data in the payload of webhooks.

• Made disallowed webhook expressions case-insensitive.

Version 1.3.0

Release date

April 22, 2024

Enhancements

• Added additional validation while saving webhooks in the Admin.

• Added a list of disallowed plugins.

Version 1.2.1

Release date

March 19, 2024

Enhancements

• Enhanced test coverage for the AdobeCommerceWebhooksAdminUi module.

Bug fixes

• Fixed integration test errors.
• Removed the Default View drop down menu from the Webhooks page of the Admin.

Version 1.2.0

Release date

February 7, 2024

Enhancements

• Added the ability to manage webhooks from the Admin, at System > Webhooks. You can now perform the following tasks:

  • Create new webhooks.
  • Modify webhooks that are defined in an XML file.
  • Modify and create webhooks rules, headers, and fields.

  The AdobeCommerceWebhooksAdminUi module provides this support.

Backward-incompatible changes

To support managing webhooks from the Admin, we introduced the method.hooks.batch.name field. This field is required and helps track changes made in the Admin. You must update all existing webhooks.xml files to include batch names. All new webhooks, whether created from a file or from the Admin, must define a batch name.

Version 1.1.0

Release date

November 30, 2023

Enhancements

• You can now define conditional webhooks that run only when configured conditions are met.

• Added support for data-modifying webhooks by introducing new response operations: add, remove, and replace.

• Added the ability to cache webhook responses and specify cache duration. The ttl attribute in the hook element of the webhooks.xml file defines the duration. Also added a new cache type, webhooks_response, to store webhook responses.

• You can now use a converter class to convert the value in a hook endpoint response object that has an operation status of replace.

Bug fixes

• Fixed a TypeError that occurred when accessing a nested field given a scalar value.

Version 1.0.0

Release date

October 10, 2023

Compatibility

Adobe Commerce for Cloud

• 2.4.4 and higher
• ece-tools 2002.1.16+

Adobe Commerce (on-premises)

• 2.4.4 and higher

Last updated 7/10/2024

Was this helpful?

Yes

No