Download the PHP package zithara/webhook without Composer
On this page you can find all versions of the php package zithara/webhook. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Table of contents
Download zithara/webhook
More information about zithara/webhook
Files in zithara/webhook
Download zithara/webhook
More information about zithara/webhook
Files in zithara/webhook
Vendor zithara
Package webhook
Short Description Zithara Magento 2 plugin for syncing Customers, Orders and Cart data from merchants magento ecommerce to Zithara.AI CRM.
License proprietary
Package webhook
Short Description Zithara Magento 2 plugin for syncing Customers, Orders and Cart data from merchants magento ecommerce to Zithara.AI CRM.
License proprietary
Please rate this library. Is it a good library?
Informations about the package webhook
Zithara Webhook Module Documentation
Overview
The Zithara Webhook module enables real-time data synchronization between Magento 2 and Zithara's API. It handles various events including cart operations, customer actions, and order processing.
Features
- Real-time cart synchronization
- Customer event tracking
- Order status updates
- Secure API authentication
- Queue-based processing
- Robust error handling and logging
Architecture
Core Components
1. Event Observers
- Cart Events (
CartSave
,CartUpdate
, etc.) - Customer Events (
CustomerSave
,CustomerLogin
, etc.) - Order Events (
OrderCreate
,OrderUpdate
, etc.) - Payment Events (
PaymentCapture
,PaymentRefund
, etc.)
2. Queue System
- Message Publishers
- Queue Processors
- Event-specific handlers
3. API Integration
- Authentication management
- API endpoints configuration
- Request/Response handling
Directory Structure
Configuration
Admin Configuration
Path: Stores > Configuration > Zithara > Webhook Settings
General Settings
- Enable/Disable Module
- API Credentials
- Client ID
- Client Secret
- Event Selection
- Retry Settings
- Maximum Retries
- Retry Delay
Queue Configuration
- Queue Names:
zithara.webhook.events
zithara.customer.events
zithara.order.events
zithara.cart.events
API Integration
Authentication
The module uses OAuth2 for API authentication:
- Obtains access token using client credentials
- Manages token expiration and refresh
- Securely stores credentials
Endpoints
Base URL: https://dev-pos-api.zithara.com/v1
Available Endpoints:
/generate-access-token
- Authentication/cart
- Cart operations/customer
- Customer operations/order
- Order operations
Data Formats
Cart Data Structure
Event Handling
Cart Events
checkout_cart_save_after
checkout_cart_update_items_after
checkout_cart_product_add_after
checkout_cart_delete
sales_quote_remove_item
Customer Events
customer_save_after
customer_login
customer_logout
customer_address_save_after
customer_delete_after
Order Events
sales_order_save_after
sales_order_place_after
order_cancel_after
sales_order_creditmemo_save_after
Payment Events
sales_order_payment_pay
sales_order_payment_capture
sales_order_payment_void
payment_cancel
Error Handling
Logging
- Location:
var/log/zithara_webhook.log
- Log Levels:
- ERROR: Critical failures
- WARNING: Non-critical issues
- INFO: Important operations
- DEBUG: Detailed debugging
Retry Mechanism
- Failed events are requeued
- Configurable retry attempts
- Exponential backoff
Installation
Requirements
- Magento 2.4.x
- PHP 7.4 or higher
- RabbitMQ/MySQL for queue management
Steps
- Copy module to
app/code/Zithara/Webhook
-
Enable module:
- Configure module in admin panel
- Set up cron jobs
Troubleshooting
Common Issues
-
Queue Processing Issues
- Check RabbitMQ connection
- Verify queue consumer is running
- Check for queue backlog
-
API Connection Issues
- Verify credentials
- Check API endpoint availability
- Review SSL certificates
- Event Processing Issues
- Check event observer registration
- Verify event data structure
- Review error logs
Debug Mode
Enable debug logging in admin configuration for detailed troubleshooting.
Security
Data Protection
- Sensitive data encryption
- Secure credential storage
- Token-based authentication
Best Practices
- Input validation
- Error handling
- Rate limiting
- Audit logging
Performance
Optimization
- Asynchronous processing
- Batch processing
- Queue management
- Cache utilization
Monitoring
- Queue length
- Processing time
- Error rates
- API response times
All versions of webhook with dependencies
PHP Build Version
Package Version
The package zithara/webhook contains the following files
Loading the files please wait ....