Sign in
webhooks

Subscribe to webhook

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.

Note: Webhooks can only be modified through the ShipStation UI under Account Settings.

post/webhooks/subscribe

Request

  • Base URL: https://ssapi.shipstation.com
  • URL: https://ssapi.shipstation.com/webhooks/subscribe
  • Auth: HTTP basic

Request body

target_urlstring required

The URL to send the webhooks to

event'ORDER_NOTIFY' | 'ITEM_ORDER_NOTIFY' | 'SHIP_NOTIFY' | 'ITEM_SHIP_NOTIFY' | 'FULFILLMENT_SHIPPED' | 'FULFILLMENT_REJECTED' required

The type of webhook to subscribe to

store_idinteger nullable

Store ID (optional - webhooks will only trigger for this store)

friendly_namestring

Display name for the webhook

Example request

{
  "target_url": "http://someexamplewebhookurl.com/neworder",
  "event": "ORDER_NOTIFY",
  "store_id": 12345,
  "friendly_name": "My Webhook"
}

Response

Webhook subscription created successfully

WebHookIDinteger
HookTypestring
Urlstring
Namestring

Example response

{
  "WebHookID": 123456
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.