Etsy · Schema

WebhookEnvelope

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

MarketplaceEcommerceHandmadeListingsOrdersPaymentsReviewsShippingTaxonomyOAuth2

Properties

Name Type Description
event_type string The triggering event name.
resource_url string A prepared Open API v3 URL the subscriber can call back to retrieve the updated resource referenced by the event.
shop_id string Identifier of the Etsy shop related to the event.
View JSON Schema on GitHub

JSON Schema

webhooks-webhook-envelope-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "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.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/etsy/refs/heads/main/json-schema/webhooks-webhook-envelope-schema.json",
  "type": "object",
  "properties": {
    "event_type": {
      "type": "string",
      "description": "The triggering event name."
    },
    "resource_url": {
      "type": "string",
      "format": "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"
  ]
}