subscribe_to_webhook
Subscribe to specific events in the ShipStation API by providing a target URL and event type. Receive real-time notifications for updates like orders or shipments directly to your endpoint.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| event | Yes | Event to subscribe to (e.g., ORDER_NOTIFY, SHIP_NOTIFY) | |
| storeId | No | Store ID to filter events (optional) | |
| targetUrl | Yes | URL to receive webhook notifications |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"event": {
"description": "Event to subscribe to (e.g., ORDER_NOTIFY, SHIP_NOTIFY)",
"type": "string"
},
"storeId": {
"description": "Store ID to filter events (optional)",
"type": "number"
},
"targetUrl": {
"description": "URL to receive webhook notifications",
"format": "uri",
"type": "string"
}
},
"required": [
"targetUrl",
"event"
],
"type": "object"
}