Etsy · JSON Structure

Webhooks Webhook Envelope Structure

Fields common to every Etsy webhook delivery, per the Etsy webhooks documentation. Per-event payloads differ but all include these three top-level fields.

Type: object Properties: 3 Required: 3
MarketplaceEcommerceHandmadeListingsOrdersPaymentsReviewsShippingTaxonomyOAuth2

WebhookEnvelope is a JSON Structure definition published by Etsy, describing 3 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

event_type resource_url shop_id

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/etsy/refs/heads/main/json-structure/webhooks-webhook-envelope-structure.json",
  "name": "WebhookEnvelope",
  "description": "Fields common to every Etsy webhook delivery, per the Etsy webhooks\ndocumentation. Per-event payloads differ but all include these three\ntop-level fields.",
  "type": "object",
  "properties": {
    "event_type": {
      "type": "string",
      "description": "The triggering event name."
    },
    "resource_url": {
      "type": "uri",
      "description": "A prepared Open API v3 URL the subscriber can call back to\nretrieve the updated resource referenced by the event."
    },
    "shop_id": {
      "type": "string",
      "description": "Identifier of the Etsy shop related to the event."
    }
  },
  "required": [
    "event_type",
    "resource_url",
    "shop_id"
  ]
}