Webhook Events

Detailed technical documentation and implementation guide for Webhook Events.

Getting Started #

# Webhook Events

A list of all available webhook events you can subscribe to. Use webhook subscriptions to receive real-time notifications about specific events happening on a site.

You can create app-specific or site-specific webhook subscriptions in JoonWeb using the REST API.
For each webhook subscription, you can define the `event` and the delivery endpoint (`address`) where notifications will be sent.
To create a new webhook subscription, send a POST request to the JoonWeb Webhooks API with parameters such as `event`, `address`, and `format`.
JoonWeb will then deliver real-time event data to your specified endpoint whenever the selected event occurs.

## Webhook Headers
When JoonWeb sends a webhook to your endpoint, the request includes the following headers for verification and context:
```http
Content-Type: application/json
X-Webhook-Signature: {hmac_signature}
X-JoonWeb-Site: example-store.myjoonweb.com
X-JoonWeb-Event: orders/create
X-JoonWeb-Event-Id: EV-123456-789
X-JoonWeb-API-Version: 26.0
```

## Verifying Webhooks
To verify that a webhook was genuinely sent by JoonWeb and hasn't been tampered with, calculate a SHA256 HMAC of the raw request payload using your **App Secret** (or Site Secret). Compare your computed hash with the `X-Webhook-Signature` header.

### PHP Verification Example
```php
<?php
// 1. Get the raw POST body
$payloadJson = file_get_contents('php://input');

// 2. Get the signature from headers
$headers = getallheaders();
$signature = $headers['X-Webhook-Signature'] ?? '';

// 3. Your App Secret
$app_secret = 'YOUR_APP_SECRET';

// 4. Calculate HMAC SHA256
$calculated_hmac = hash_hmac('sha256', $payloadJson, $app_secret);

// 5. Compare signatures safely
if (hash_equals($calculated_hmac, $signature)) {
    echo "Webhook verified!";
} else {
    http_response_code(401);
    echo "Webhook verification failed!";
}
?>
```

Webhook Events #

app_billings/update

app/uninstalled

app/scope_update

carts/create

carts/update

checkouts/create

checkouts/update

checkouts/delete

customers/create

customers/update

orders/create

orders/update

orders/cancelled

orders/paid

orders/partially_shipped

orders/shipped

shipping/create

shipping/update

shipping/cancelled

returns/approve

returns/request

returns/update

returns/complete

Webhook Payload

Select an event to view its payload

Last modified: Aug 27, 2026

Webhook Events

Getting Started #

Webhook Events #

Endpoint Title