Stock Update Webhook

Stock Updated Webhook

post

This is a dummy endpoint that demonstrates the webhook payload structure that will be sent to webhook subscribers when a stock.updated event occurs.

The actual webhooks will be sent asynchronously to the URLs specified in the webhook subscriptions that are subscribed to the stock.updated event type.

The webhook payload includes:

  • id: ID of the webhook message

  • event: The event type (stock.updated)

  • timestamp: When the event occurred

  • subscription_id: ID of the webhook subscription

  • message: The stock data in the same format as the GET /stock endpoint

Authorizations
Body
idinteger · min: 1Required

ID of the webhook message

Example: 1
eventstringRequired

Event type of webhook message

timestampstring · date-timeOptional

UTC timestamp when the event was created

subscription_idany ofOptional

ID of the subscription

integer · min: 1Optional

ID (integer) of this property

Example: 1
or
nullOptional
Responses
200

OK

post
POST /api/v1/webhooks/stock-updated HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 147

{
  "id": 1,
  "event": "text",
  "timestamp": "2025-08-23T13:59:42.138Z",
  "message": [
    {
      "sku": "my_sku_1",
      "quantity": 100,
      "quantity_fbm": 100
    }
  ],
  "subscription_id": 1
}
200

OK

No content

Last updated

Was this helpful?