# Gearment Webhook API

The Gearment Webhook API provides real-time notifications for critical order and product events—such as order completion, cancellation, shipping updates, stock changes, and variant modifications—across multiple payload versions to ensure seamless integration with your existing systems.


Version: 1.0.0

## Servers

Your Webhook URL
```
https://your-webhook-url
```

## Security

### ApiKeyAuth

API key for authenticating webhook registrations

Type: apiKey
In: header
Name: X-API-Key

## Download OpenAPI description

[Gearment Webhook API](https://developers.gearment.com/_bundle/webhook.yaml)

## Payload

Webhook events that can be received from Gearment

### Order Completed

 - [POST order_completed](https://developers.gearment.com/webhook/payload/paths/order_completed/post.md): Triggered when an order is completed and shipped to the customer

### Order Cancelled

 - [POST order_cancelled](https://developers.gearment.com/webhook/payload/paths/order_cancelled/post.md): Triggered when an order is cancelled

### Order Tracking Updated

 - [POST tracking_updated](https://developers.gearment.com/webhook/payload/paths/tracking_updated/post.md): Triggered when tracking information for an order is added or updated

### Order On Hold

 - [POST order_on_hold](https://developers.gearment.com/webhook/payload/paths/order_on_hold/post.md): Triggered when an order is placed on hold

### Shipping Address Verified

 - [POST shipping_address_verified](https://developers.gearment.com/webhook/payload/paths/shipping_address_verified/post.md): Triggered when a shipping address is verified

### Shipping Address Unverified

 - [POST shipping_address_unverified](https://developers.gearment.com/webhook/payload/paths/shipping_address_unverified/post.md): Triggered when a shipping address cannot be verified

### Product Variant Out of Stock

 - [POST product_out_of_stock](https://developers.gearment.com/webhook/payload/paths/product_out_of_stock/post.md): Triggered when a product variant goes out of stock

### Variant Created

 - [POST variant_created](https://developers.gearment.com/webhook/payload/paths/variant_created/post.md): Triggered when a new product variant is created

### Variant Updated

 - [POST variant_updated](https://developers.gearment.com/webhook/payload/paths/variant_updated/post.md): Triggered when a product variant is updated