Sign in
latestOpenAPI 3.1.0MIT2026-08-221643491.4 MB

d3d8c21cd227

webhooks

Create a webhook

<aside class="access" aria-label="Endpoint access"> <table class="access__table"> <thead> <tr> <th class="access__table-header">Products</th> <th class="access__table-header">Plans</th> </tr> </thead> <tbody> <tr> <td class="access__table-cell access__product"> <img class="access__logo" src="/static/logos/shipstation-api-logo.svg" alt="ShipStation API Logo" loading="lazy" decoding="async"/> <div class="access__sub">Formerly ShipEngine</div> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-free.md" class="access__plan">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Advanced</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Enterprise</a> </td> </tr> <tr> <td class="access__table-cell"> <img class="access__logo" src="/static/logos/shipstation-logo.svg" alt="ShipStation Logo" loading="lazy" decoding="async"/> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Starter</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Standard</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Premium</a> </td> </tr> </tbody> </table> <footer class="access__footer"> <a class="access__help" href="/apis/@shipstation-v2/docs/getting-started/products-and-plans.md"> Learn about products and plans <img src="/static/icons/external-link.svg" alt="External Link Icon" style="width: 16px;" loading="lazy" decoding="async"/> </a> </footer> </aside>

Create a webhook for specific events in the environment.

post/v2/environment/webhooks

Request body

namestring required

The name of the webhook

event'batch' | 'carrier_connected' | 'order_source_refresh_complete' | 'rate' | 'report_complete' | 'sales_orders_imported' | 'track' | 'batch_processed_v2' | 'fulfillment_rejected_v2' | 'fulfillment_shipped_v2' | 'label_created_v2' | 'shipment_created_v2' | 'track_event_v2' required

The possible webhook event values

urlstring url required

A URL

store_idinteger

Store ID

Example request

{
  "name": "My New Webhook",
  "url": "https://example.com/resource",
  "headers": [
    {
      "key": "custom-key",
      "value": "custom-value"
    }
  ],
  "store_id": 123456
}

Response

The request was a success.

webhook_idstring

A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.

urlstring url

A URL

event'batch' | 'carrier_connected' | 'order_source_refresh_complete' | 'rate' | 'report_complete' | 'sales_orders_imported' | 'track' | 'batch_processed_v2' | 'fulfillment_rejected_v2' | 'fulfillment_shipped_v2' | 'label_created_v2' | 'shipment_created_v2' | 'track_event_v2'

The possible webhook event values

namestring

The name of the webhook

store_idinteger

Store ID

Example response

{
  "webhook_id": "se-28529731",
  "url": "https://example.com/resource",
  "headers": [
    {
      "key": "custom-key",
      "value": "custom-value"
    }
  ],
  "name": "My Webhook",
  "store_id": 123456
}