ShipStation · Schema

WebhookCreateRequest

EcommerceLabelsLogisticsOrder ManagementShippingWarehousing

Properties

Name Type Description
target_url string The URL where webhook events will be sent
event string
store_id string
friendly_name string
View JSON Schema on GitHub

JSON Schema

shipstation-webhookcreaterequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WebhookCreateRequest",
  "title": "WebhookCreateRequest",
  "type": "object",
  "required": [
    "target_url",
    "event"
  ],
  "properties": {
    "target_url": {
      "type": "string",
      "description": "The URL where webhook events will be sent"
    },
    "event": {
      "type": "string",
      "enum": [
        "ORDER_NOTIFY",
        "ITEM_ORDER_NOTIFY",
        "SHIP_NOTIFY",
        "ITEM_SHIP_NOTIFY"
      ]
    },
    "store_id": {
      "type": "string"
    },
    "friendly_name": {
      "type": "string"
    }
  }
}