WooCommerce Webhooks
The Asaas Plugin uses Webhooks to keep your store’s orders synchronized with Asaas payment events.
Whenever a charge is created, paid, overdue, reversed, or undergoes any relevant change, Asaas automatically sends an event to WooCommerce, allowing the order status to be updated without the need for periodic queries (polling).
Automatic configurationAs of version 2.5 of the Asaas Plugin, no manual configuration is required.
When entering a valid API Key in the plugin settings, the Webhook is automatically created and configured in your Asaas account.
How to check the Webhooks status
After configuring the integration, you can monitor the health of the communication between WooCommerce and Asaas directly through the store’s administrative panel.
There are two places where the Webhooks queue status can be checked.
WooCommerce > Status
Access WooCommerce > Status and locate the Asaas Payment Method section.
In this area, information such as the following is displayed:
- connection status with Asaas;
- Webhooks queue status;
- availability of the Re-enable webhooks queue button, when necessary.
When the queue is working normally, the connection with Asaas and Webhooks synchronization will be displayed as active.
If an interruption is identified, the queue status will be changed and the Re-enable webhooks queue button will become available to request the resumption of synchronization.
Payment method settings
The same information can also be checked in the settings of any payment method made available by the Asaas Plugin.
In addition to the queue status, this screen allows you to configure an email for alerts, used to receive notifications if Webhooks synchronization is interrupted.
Email for alertsWe recommend entering an email address monitored by the team responsible for the store’s operation.
If the Webhooks queue is interrupted due to an error, this address will be used to send automatic notifications.
When the queue is interrupted
If any communication problem occurs between WooCommerce and Asaas, the Plugin will automatically identify the interruption of the Webhooks queue.
In this situation:
- the queue status will be displayed as interrupted on the monitoring pages;
- the Re-enable webhooks queue button will become available;
- a warning will be displayed on the WooCommerce Orders screen informing that synchronization was interrupted.
In addition, the Webhook section itself in the payment method settings will also display the queue interruption and allow its reactivation to be requested.
After clicking Re-enable webhooks queue, the Plugin will automatically request Asaas to resume synchronization.
If the queue remains interrupted after reactivation, consult the Webhook Logs in your Asaas account to identify the cause of the problem before contacting support.
Best practices
Recommendations
- keep a valid API Key configured;
- enter an email address to receive alerts;
- periodically monitor the connection status in WooCommerce > Status;
- re-enable the queue whenever there is an interruption;
- consult the Webhook Logs if the queue remains interrupted after reactivation;
- keep the Asaas Plugin always updated to use the latest improvements and fixes.
Related content
Continue the configurationAfter understanding how Webhooks work, also see:
- Initial settings
- Payment method
- Common errors
- How to view Webhook Logs