Skip to main content
GET
/
api
/
v1
/
webhooks
/
topics
Webhook Topics
curl --request GET \
  --url https://api.launchmystore.io/api/v1/webhooks/topics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "topic": "<string>",
  "address": "<string>",
  "format": "<string>",
  "fields": [
    {}
  ]
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.launchmystore.io/llms.txt

Use this file to discover all available pages before exploring further.

Webhook Topics

LaunchMyStore supports 31 webhook topics that notify your app when events occur in the merchant’s store. Subscribe to these topics to receive real-time notifications.

Available Topics

Orders

TopicDescription
orders/createFired when a new order is created
orders/updatedFired when an order is updated
orders/paidFired when an order payment is completed
orders/cancelledFired when an order is cancelled
orders/fulfilledFired when all items in an order are fulfilled
orders/partially_fulfilledFired when some items in an order are fulfilled

Products

TopicDescription
products/createFired when a new product is created
products/updateFired when a product is updated
products/deleteFired when a product is deleted

Collections

TopicDescription
collections/createFired when a new collection is created
collections/updateFired when a collection is updated
collections/deleteFired when a collection is deleted

Customers

TopicDescription
customers/createFired when a new customer is created
customers/updateFired when a customer is updated
customers/deleteFired when a customer is deleted
customers/enableFired when a customer account is enabled
customers/disableFired when a customer account is disabled

Inventory

TopicDescription
inventory_levels/updateFired when inventory levels change
inventory_levels/connectFired when inventory is connected to a location
inventory_levels/disconnectFired when inventory is disconnected from a location

Fulfillments

TopicDescription
fulfillments/createFired when a fulfillment is created
fulfillments/updateFired when a fulfillment is updated

Refunds

TopicDescription
refunds/createFired when a refund is created

Carts

TopicDescription
carts/createFired when a new cart is created
carts/updateFired when a cart is updated

Checkouts

TopicDescription
checkouts/createFired when a checkout is created
checkouts/updateFired when a checkout is updated

App

TopicDescription
app/uninstalledFired when your app is uninstalled from a store

Shop

TopicDescription
shop/updateFired when shop settings are updated

Themes

TopicDescription
themes/publishFired when a theme is published
themes/updateFired when theme settings are updated

Subscribing to Webhooks

Create a webhook subscription using the API:
curl -X POST "https://api.launchmystore.io/api/v1/webhooks" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "topic": "orders/create",
    "address": "https://your-app.com/webhooks/orders",
    "format": "json"
  }'

Webhook Subscription Parameters

topic
string
required
The webhook topic to subscribe to
address
string
required
The HTTPS URL where webhook payloads will be sent
format
string
default:"json"
Payload format: json or xml
fields
array
Specific fields to include in the webhook payload (optional)

Webhook Delivery

Webhooks are delivered with:
  • Method: POST
  • Content-Type: application/json
  • Retry Policy: 3 attempts with exponential backoff (1min, 5min, 15min)
  • Timeout: 10 seconds

Required Headers in Response

Your endpoint must return a 2xx status code within 10 seconds to acknowledge receipt. Failed deliveries are retried automatically.

Listing Subscriptions

curl -X GET "https://api.launchmystore.io/api/v1/webhooks" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Deleting a Subscription

curl -X DELETE "https://api.launchmystore.io/api/v1/webhooks/webhook_abc123" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"