Webhooks

Introduction

The Webhooks section in your admin portal allows you to configure real-time data synchronization between your store and external services. Set up automated notifications for orders, users, products, and other events to keep your integrated systems up-to-date with the latest changes in your platform.

Accessing Webhook Management

1. Log in to your Admin portal
2. Navigate to Settings → Webhooks in the left navigation sidebar
3. You'll see the Webhooks dashboard displaying all configured webhooks

Webhook Dashboard

Main View

The Webhooks dashboard displays key information for each configured webhook: • Resource - The type of data being monitored (e.g., order, product) • Event - The specific action that triggers the webhook (e.g., created) • URL - The destination endpoint where data will be sent • Status - Current operational state of the webhook (Active/Inactive)

Dashboard Controls

• Create Webhook Button - Located in the top right to add new webhooks • Search Bar - Filter webhooks by resource, event, or URL • View Controls - Switch between different webhook views and filters

Managing Webhooks

Creating a New Webhook

1. Click the "Create Webhook" button in the top right corner
2. Fill in the webhook configuration: • Resource - Select the data type to monitor • Event - Choose which action triggers the webhook • Destination URL - Enter the HTTP/HTTPS endpoint • Authentication - Configure any required authentication tokens
3. Test the webhook connection (if available)
4. Click "Save" to activate the webhook

Editing an Existing Webhook

1. Locate the webhook you want to modify
2. Click the ellipsis menu (⋮) on the right side of the webhook row
3. Select "Edit" from the dropdown menu
4. Update the webhook configuration as needed
5. Save your changes

Deleting a Webhook

1. Find the webhook you want to remove
2. Click the ellipsis menu (⋮) on the right side
3. Select "Delete" from the dropdown menu
4. Confirm the deletion when prompted
5. The webhook will be immediately removed and stop sending data
    

Webhook Status Management

Active Webhooks

• Green Status Indicator - Webhook is operational and sending data • Real-time Processing - Events are processed and sent immediately • Retry Logic - Failed deliveries are automatically retried

Inactive Webhooks

• Gray Status Indicator - Webhook is paused and not sending data • Event Queuing - Events may be queued or discarded based on configuration • Manual Reactivation - Requires user action to resume operation
 

Best Practices for Webhook Management

When to Create Webhooks

• System Integration - Connect with CRM, ERP, or analytics platforms • Real-time Notifications - Alert systems about critical business events • Data Synchronization - Keep multiple systems in sync automatically • Automation Workflows - Trigger automated processes based on store events

Security Considerations

• Use HTTPS - Always use secure endpoints for webhook destinations • Authentication Tokens - Implement webhook signatures or API keys • IP Whitelisting - Restrict access to webhook endpoints when possible • Payload Validation - Verify webhook data integrity on the receiving end

Performance Optimization

• Endpoint Reliability - Ensure destination servers can handle webhook volume • Response Times - Keep webhook processing under 5 seconds • Error Handling - Implement proper error responses and logging • Rate Limiting - Be aware of any rate limits on receiving systems

Monitoring Webhook Health

Key Metrics to Track

• Delivery Success Rate - Percentage of successful webhook deliveries • Response Time - How quickly endpoints acknowledge webhook calls • Error Frequency - Pattern of failures indicating endpoint issues • Queue Depth - Number of pending webhook deliveries

Troubleshooting Common Issues

• Connection Timeouts - Verify endpoint accessibility and response times • Authentication Failures - Check and update credentials or tokens • Invalid Payloads - Ensure endpoint expects the correct data format • Rate Limit Errors - Adjust webhook frequency or batch events

Webhook Event Types

Common Resources and Events

• Orders - created, updated, fulfilled, cancelled • Products - created, updated, deleted, inventory_updated • Customers - created, updated, deleted • Payments - completed, failed, refunded • Shipping - label_created, tracking_updated, delivered

Payload Structure

Each webhook delivers a standardized JSON payload containing: • Event metadata - Timestamp, event type, and unique identifiers • Resource data - Complete object data for the affected resource • Related data - Associated information based on the event type