CLI Reference

whatalo webhook trigger

Send a test webhook event to your plugin during local development — no real orders or customers required.

Syntax

whatalo webhook trigger [event] [options]

Options

FlagTypeDescription
--store <id>stringTarget dev store to use as event origin
--listbooleanPrint all available events and exit
--payload <file>stringPath to a custom JSON payload file
--jsonbooleanOutput result as JSON
--portal-url <url>stringDeveloper Portal URL

Available Events

Run whatalo webhook trigger --list to see all events.

CategoryEvent
OrdersORDER_CREATED
OrdersORDER_UPDATED
OrdersORDER_CANCELLED
ProductsPRODUCT_CREATED
ProductsPRODUCT_UPDATED
ProductsPRODUCT_DELETED
CustomersCUSTOMER_CREATED
CustomersCUSTOMER_UPDATED
CheckoutCHECKOUT_COMPLETED

Security

whatalo webhook trigger only works against development stores. Attempting to trigger a webhook against a production store returns a 403 error. This restriction is enforced server-side.

Delivery Details

The webhook is delivered to your plugin's configured endpoint:

PropertyValue
Target URLmanifest.webhookUrl or active dev session tunnel URL
Timeout15 seconds
Header: SignatureX-Webhook-Signature (HMAC-SHA256)
Header: EventX-Webhook-Event
Header: IDX-Webhook-ID

The signature uses the same algorithm as real webhooks. Your src/webhooks/verify.ts file (scaffolded by whatalo init) handles verification including replay protection.

Examples

List all available events:

whatalo webhook trigger --list

Trigger a test order creation:

whatalo webhook trigger ORDER_CREATED

Trigger with a specific dev store:

whatalo webhook trigger ORDER_CREATED --store my-dev-store

Trigger with a custom payload from a file:

whatalo webhook trigger ORDER_CREATED --payload ./test-payloads/big-order.json

Trigger and capture the result as JSON:

whatalo webhook trigger CHECKOUT_COMPLETED --json

Custom Payloads

By default, the CLI sends a realistic sample payload for each event type. To override it, create a JSON file with the desired structure and pass it with --payload:

{
  "id": "819365047283",
  "total": "199.99",
  "currency": "DOP",
  "status": "confirmed",
  "customer": {
    "name": "María García",
    "email": "[email protected]"
  }
}
whatalo webhook trigger ORDER_CREATED --payload ./my-payload.json

On this page