Skip to content

Outbound Webhooks

Outbound webhooks let you subscribe to wishlist events and receive HTTP POST notifications in real time. Use them to trigger automations, sync data to external systems, or build custom integrations.

Events

EventDescription
wishlist.item.addedA customer added a product to their wishlist
wishlist.item.removedA customer removed a product from their wishlist
wishlist.sharedA customer generated a share link

Create a webhook

Terminal window
POST /v1/webhooks

Request body

{
"url": "https://your-server.com/hooks/wishlist",
"events": ["wishlist.item.added", "wishlist.item.removed"]
}

Response

{
"ok": true,
"data": {
"webhookId": "wh_abc123",
"url": "https://your-server.com/hooks/wishlist",
"events": ["wishlist.item.added", "wishlist.item.removed"],
"createdAt": "2026-02-16T00:00:00.000Z"
}
}

List webhooks

Terminal window
GET /v1/webhooks

Delete a webhook

Terminal window
DELETE /v1/webhooks/{webhookId}

Payload format

All webhook payloads are JSON POST requests with the following structure:

{
"event": "wishlist.item.added",
"timestamp": "2026-02-16T10:30:00.000Z",
"shop": "your-store.myshopify.com",
"data": {
"customerId": "12345",
"productId": "8012345678",
"variantId": "44012345678"
}
}