{"templateId":"markdown","versions":[{"version":"shipstation-v2","label":"ShipStation V2 API","link":"/apis/shipstation-v2/docs/webhooks/subscribe","default":true,"active":false,"folderId":"58c9a61d"},{"version":"shipengine","label":"ShipStation API (formerly ShipEngine)","link":"/apis/shipengine/docs/webhooks/subscribe","default":false,"active":false,"folderId":"58c9a61d"},{"version":"shipstation-v1","label":"ShipStation V1 API","link":"/apis/shipstation-v1/docs/webhooks/subscribe","default":false,"active":true,"folderId":"58c9a61d"}],"sharedDataIds":{"sidebar":"sidebar-apis/@shipengine/sidebars.yaml","oas-apis/@shipstation-v1/openapi.yaml":"oas-apis/@shipstation-v1/openapi.yaml"},"props":{"metadata":{"markdoc":{"tagList":["openapi-code-sample","replay-openapi"]},"type":"markdown"},"seo":{"title":"Subscribe to Webhook","keywords":"shipping, labels, shipstation, documentation, api","siteUrl":"https://docs.shipstation.com","lang":"en-US","llmstxt":{"hide":false,"title":"ShipStation API LLM Docs","description":"Find links and references to all markdown documentation for use with LLMs","excludeFiles":[]}},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"subscribe-to-webhook","__idx":0},"children":["Subscribe to Webhook"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Subscribes to a specific type of webhook. If a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["store_id"]}," is passed in, the webhooks will only be triggered for that specific ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["store_id"]},". The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["event"]}," type that is passed in will determine what type of webhooks will be sent."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["IMPORTANT"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Webhooks will be sent to the URL specified in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["target_url"]},". The HTTP request will be sent via POST and will contain a ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipstation-v1/docs/models/webhook"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["webhook JSON object"]}]}," in the body."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Regardless of how the webhook was created"]},", you can only ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["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 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Settings > Integrations > Integration Partners"]}," under Integrations in the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://ss.shipstation.com/#/settings/integrations"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Account Settings"]}]},". Learn more about webhooks in ShipStation's UI in this ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://help.shipstation.com/hc/en-us/articles/360025856252"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["ShipStation Webhooks KB article"]}]},"."]}]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-apis/@shipstation-v1/openapi.yaml","operationId":"subscribe_webhook","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"ReplayOpenApi","attributes":{"descriptionFile":"oas-apis/@shipstation-v1/openapi.yaml","operationId":"subscribe_webhook","parameters":{},"options":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-resources","__idx":1},"children":["Related Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipstation-v1/docs/models/webhook"},"children":["Webhook Model"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipstation-v1/docs/webhooks/unsubscribe"},"children":["Unsubscribe from Webhook"]}]}]}]},"headings":[{"value":"Subscribe to Webhook","id":"subscribe-to-webhook","depth":1},{"value":"Related Resources","id":"related-resources","depth":2}],"frontmatter":{"seo":{"title":"Subscribe to Webhook"}},"lastModified":"2026-04-08T10:47:45.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/shipstation-v1/docs/webhooks/subscribe","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}