Webhooks commands
Adobe Commerce provides the following commands to configure and process webhooks:
Display the payload of a webhook
The webhooks:info command returns the payload of the specified webhook. You can optionally specify the depth of the payload to reduce the amount data returned.
The actual payload of a transmitted webhook can be different from that returned by the webhooks:info. The command response is based on the current state of objects and variables.
The value of the webhook-name argument must be a valid Commerce event name. The value must use the following pattern:
Copied to your clipboard<type>.<event_name>
where:
typespecifies the origin of the event. Specifyobserverif the event is emitted by a Commerce observer, or specify plugin if the event is based on resource model methods or API interfaces.event_nameidentifies the event. For example:catalog_product_save_after.
Usage
bin/magento webhooks:info <webhook-name> [--webhook-type="<value>"] [--depth=<integer>]
Arguments
<webhook-name> Required. The name must begin with either observer. or plugin.
--webhook-type Optional. Indicates whether the plugin that generates the event is a before or after plugin. The default value is before. around plugins are not supported.
Options
--depth=<integer> Determines how many nested levels of the payload to return. The default value is 3.
Example
Copied to your clipboardbin/magento webhooks:info observer.catalog_product_save_before
Response
Copied to your clipboard{"eventName": "string","data": {"data_object": {"store_id": "int","name": "string","price": "float","visibility": "int","attribute_set_id": "int","created_at": "string","updated_at": "string","type_id": "array","status": "int","category_id": "int","category": {"products_position": "array","store_ids": "array","store_id": "int","url": "string","parent_category": "\Magento\Catalog\Model\Category","parent_id": "int","custom_design_date": "array","path_ids": "array","level": "int","request_path": "string","name": "string","product_count": "int","available_sort_by": "array","default_sort_by": "string","path": "string","position": "int","children_count": "int","created_at": "string","updated_at": "string","is_active": "bool","category_id": "int","display_mode": "string","include_in_menu": "bool","url_key": "string","children_data": "\Magento\Catalog\Api\Data\CategoryTreeInterface[]"},"category_ids": "array","website_ids": "array","store_ids": "array","qty": "float","data_changed": "bool","calculated_final_price": "float","minimal_price": "float","special_price": "float","special_from_date": "mixed","special_to_date": "mixed","related_products": "array","related_product_ids": "array","up_sell_products": "array","up_sell_product_ids": "array","cross_sell_products": "array","cross_sell_product_ids": "array","media_attributes": "array","media_attribute_values": "array","media_gallery_images": {"loaded": "bool","last_page_number": "int","page_size": "int","size": "int","first_item": "\Magento\Framework\DataObject","last_item": "\Magento\Framework\DataObject","items": "\Magento\Framework\DataObject[]","all_ids": "array","new_empty_item": "\Magento\Framework\DataObject","iterator": "\ArrayIterator"},"salable": "bool","is_salable": "bool","custom_design_date": "array","request_path": "string","gift_message_available": "string","options": [{"product_sku": "string","option_id": "int","title": "string","type": "string","sort_order": "int","is_require": "bool","price": "float","price_type": "string","sku": "string","file_extension": "string","max_characters": "int","image_size_x": "int","image_size_y": "int","values": "\Magento\Catalog\Api\Data\ProductCustomOptionValuesInterface[]","extension_attributes": "\Magento\Catalog\Api\Data\ProductCustomOptionExtensionInterface"}],"preconfigured_values": {"empty": "bool"},"identities": "array","id": "int","quantity_and_stock_status": "array","stock_data": "array"}}}
Return a list of supported webhook event names
The webhooks:list:all command returns a list of events defined in the specified module that can be used as the trigger for a webhook.
Usage
bin/magento webhooks:list:all <module_name>
Arguments
<module_name> Required. Specifies the module to query.
Example
Copied to your clipboardbin/magento webhooks:list:all Magento_Sales
Response
Copied to your clipboardobserver.admin_sales_order_address_updateobserver.adminhtml_customer_orders_add_action_rendererobserver.adminhtml_sales_order_create_process_dataobserver.adminhtml_sales_order_create_process_data_beforeobserver.adminhtml_sales_order_create_process_item_after...plugin.magento.sales.api.creditmemo_comment_repository.deleteplugin.magento.sales.api.creditmemo_comment_repository.saveplugin.magento.sales.api.creditmemo_item_repository.deleteplugin.magento.sales.api.creditmemo_item_repository.saveplugin.magento.sales.api.creditmemo_management.cancel...
Return a list of subscribed webhooks
The webhooks:list command returns details about all subscribed webhooks. The response contains the webhook name and the type of plugin that calls the webhook, (before or after). The batch column of the response contains a list of hooks that can be executed in parallel.
Usage
bin/magento webhooks:list
Example
Copied to your clipboardbin/magento webhooks:list
Response
Copied to your clipboardok | 10:25:24 AM+-------------------------------------------+--------+---------------------------------------------------------------------------+| name | type | batches |+-------------------------------------------+--------+---------------------------------------------------------------------------+| observer.catalog_product_save_after | after | [ || | | [ || | | { || | | "name": "product_updated", || | | "url": "{env:APP_BUILDER_PROJECT_URL}\/product-updated", || | | "method": "", || | | "headers": [ || | | "x-gw-ims-org-id : {env:APP_BUILDER_IMS_ORG_ID}", || | | "Authorization : Bearer {env:APP_BUILDER_AUTH_TOKEN}", || | | "Magento\\WebhookModule\\Model\\AddProductToCartResolver" || | | ], || | | "fields": [ || | | "product.name : data.product.name", || | | "product.category_ids : data.product.category_ids", || | | "product.sku : data.product.sku" || | | ] || | | } || | | ] || | | ] || observer.checkout_cart_product_add_before | before | [ || | | [ || | | { || | | "name": "validate_stock", || | | "url": "http:\/\/localhost:8085\/product-validate-stock", || | | "method": "", || | | "headers": [ || | | "Magento\\WebhookModule\\Model\\AddProductToCartResolver" || | | ], || | | "fields": [ || | | "product.name : data.product.name", || | | "product.category_ids : data.product.category_ids", || | | "product.sku : data.product.sku" || | | ] || | | } || | | ] || | | ] |+-------------------------------------------+--------+---------------------------------------------------------------------------+
Generate plugins
The webhooks:generate:module command generates the AdobeCommerceWebhookPlugins module with plugins based on webhook registrations and places it into the Commerce app/code/Magento directory. This command is applicable for on-premises deployments only.
Usage
bin/magento webhooks:generate:module
Example
Copied to your clipboardbin/magento webhooks:generate:module
Response
Copied to your clipboardModule was generated in the app/code/Magento directory
Emulate webhook execution
The webhooks:dev:run command is used for development and testing purposes only. It emulates the execution of your registered webhook containing a custom payload without requiring changes to the Commerce application. Testing webhooks further describes how to run this command.
Usage
bin/magento webhooks:dev:run <webhook-name> <webhook-arguments-payload>
Arguments
<webhook-name:type> Required. The combination of webhook name and type. The name must begin with either observer. or plugin.. The type must be either before or after. Example: observer.checkout_cart_product_add_before:before
<webhook-arguments-payload> Required. The webhook arguments payload in JSON format. The payload will be filtered according to the fields rules defined in a webhooks.xml file before being sent to the webhook endpoint. This emulates how the real arguments will be filtered in the generated plugin for the webhook.
Example
Copied to your clipboardbin/magento webhooks:dev:run observer.checkout_cart_product_add_before:before '{"data":{"product":{"sku":"simple-product","name":"Simple Product"}}}'
The webhook endpoint receives the following payload, according to fields configured for the webhook:
Copied to your clipboard{"product":{"name":"Simple Product","sku":"simple-product"}}
