WooWebhook class

WooCommerce Webhook Model

Represents a webhook configuration in WooCommerce. Webhooks are HTTP callbacks that are triggered by specific events in your store, allowing you to receive real-time notifications about store activities.

Webhook Structure

A webhook consists of several key components:

• Identification: Unique ID and human-readable name
• Event Subscription: Topic that determines which events trigger the webhook
• Delivery Configuration: URL where payloads are sent and optional secret for verification
• Status Management: Control whether the webhook is active, paused, or disabled
• Timestamps: Creation and modification tracking

Webhook Lifecycle

1. Creation: Webhook is created with topic and delivery URL
2. Activation: Status is set to 'active' to start receiving events
3. Delivery: WooCommerce sends HTTP POST requests to the delivery URL
4. Verification: Optional HMAC-SHA256 signature verification using the secret
5. Management: Update, pause, or delete as needed

Security Features

• Secret Key: Optional HMAC-SHA256 signature for payload verification
• HTTPS Support: Delivery URLs must use HTTP or HTTPS
• Status Control: Pause or disable webhooks without deletion

Example Usage

// Create a new webhook
final webhook = WooWebhook(
  name: 'Order Updates',
  topic: 'order.updated',
  deliveryUrl: 'https://your-app.com/webhooks/orders',
  secret: 'your-secret-key',
  status: WooWebhookStatus.active,
);

// Create webhook via API
final createdWebhook = await wooCommerce.createWebhook(webhook);

// Update webhook status
webhook.status = WooWebhookStatus.paused;
await wooCommerce.updateWebhook(webhook);

// Generate fake webhook for testing
final fakeWebhook = WooWebhook.fake();

Webhook Delivery Headers

When a webhook is delivered, WooCommerce includes these headers:

• X-WC-Webhook-Source: Store URL
• X-WC-Webhook-Topic: The topic that triggered the webhook
• X-WC-Webhook-Resource: Resource type (e.g., 'order', 'product')
• X-WC-Webhook-Event: Event type (e.g., 'created', 'updated')
• X-WC-Webhook-Signature: HMAC-SHA256 signature (if secret is set)
• X-WC-Webhook-ID: Webhook's ID
• X-WC-Webhook-Delivery-ID: Delivery log ID