Shippo · Schema

Webhook

EcommerceLabelsLogisticsReturnsShippingTracking

Properties

Name	Type	Description
object_id	string
url	string	URL that receives webhook events
event	string
active	boolean
is_test	boolean
object_created	string
object_updated	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Webhook",
  "title": "Webhook",
  "type": "object",
  "properties": {
    "object_id": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "description": "URL that receives webhook events"
    },
    "event": {
      "type": "string",
      "enum": [
        "transaction_created",
        "transaction_updated",
        "batch_created",
        "batch_purchased",
        "track_updated"
      ]
    },
    "active": {
      "type": "boolean"
    },
    "is_test": {
      "type": "boolean"
    },
    "object_created": {
      "type": "string",
      "format": "date-time"
    },
    "object_updated": {
      "type": "string",
      "format": "date-time"
    }
  }
}