Subscribes to a specific type of webhook. If a store_id is passed in, the webhooks will only be triggered for that specific store_id. The event type that is passed in will determine what type of webhooks will be sent.
IMPORTANT
Webhooks will be sent to the URL specified in the
target_url. The HTTP request will be sent via POST and will contain a webhook JSON object in the body.Regardless of how the webhook was created, you can only modify an existing webhook through your ShipStation UI and application account Settings. To view and edit your webhooks via the application UI, log in to ShipStation and go to Settings > Integrations > Integration Partners under Integrations in the Account Settings. Learn more about webhooks in ShipStation's UI in this ShipStation Webhooks KB article.
- Production Serverhttps://ssapi.shipstation.com/webhooks/subscribe
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://ssapi.shipstation.com/webhooks/subscribe \
-H 'Content-Type: application/json' \
-d '{
"target_url": "http://someexamplewebhookurl.com/neworder",
"event": "ORDER_NOTIFY",
"store_id": 12345,
"friendly_name": "My Webhook"
}'