Full API Reference
/
Webhooks
/
Create a webhook

ShipStation API v2 (2.0.0)

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License MIT
Languages
Servers
Mock server
https://docs.shipstation.com/_mock/openapi/
Production
https://api.shipstation.com/

Batches

Process labels in bulk and receive a large number of labels and customs forms in bulk responses. Batching is ideal for workflows that need to process hundreds or thousands of labels quickly.

Operations

Carriers

Retreive useful details about the carriers connected to your accounts, including carrier IDs, service IDs, advanced options, and available carrier package types.

Operations

Downloads

Download your label files in PDF, PNG, and ZPL.

Operations

Labels

Purchase and print shipping labels for any carrier active on your account. The labels endpoint also supports creating return labels, voiding labels, and getting label details like tracking.

Operations

Manifests

A manifest is a document that provides a list of the day's shipments. It typically contains a barcode that allows the pickup driver to scan a single document to register all shipments, rather than scanning each shipment individually.

Operations

Package Pickups

Scheduled pickups and manage pickup requests for supported carriers.

Operations

Package Types

Create custom package types to use for your shipments, rather than the carriers' default package types.

Operations

Rates

Quickly compare rates using the Rates endpoint. You can see and compare rates for the carriers connected to your account (as long as they support sending rates).

Operations

Shipments

Shipments are at the core of most ShipStation capabilities. Shipment objects are required for cretaing labels and manifests, as well as getting rates.

Operations

Tags

Tags are text-based identifiers you can add to shipments to help in your shipment management workflows.

Operations

Tracking

Use the tracking endpoint to stop receiving tracking updates (more dedicated tracking endpoint methods coming soon).

Operations

Warehouses

Get warehouse details like warehouse ID and related addresses using the warehouses endpoint.

Operations

Webhooks

Webhooks are a powerful feature that can save you from sending repeated polling requests to check on the state of something. With webhooks, ShipStation will automatically contact your servers when the stage changes. This can include parcel tracking events, notification when a batch operation completes, and more.

Operations

List webhooks

Request

List all webhooks currently enabled for the account.

curl -i -X GET \
  https://docs.shipstation.com/_mock/openapi/v2/environment/webhooks \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

The request was a success.

Bodyapplication/jsonArray [
webhook_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$read-only

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

Example: "se-28529731"
urlstring(url)(url)non-empty

A URL

Example: "http://api.shipstation.com/v2/labels/se-28529731"
eventstring(webhook_event)

The possible webook event values

Enum"batch""carrier_connected""order_source_refresh_complete""rate""report_complete""sales_orders_imported""track"
headersArray of objects(webhook_header)

Array of custom webhook headers

]
Response
application/json
[
  {
    "webhook_id": "se-28529731",
    "url": "https://[YOUR ENDPOINT ID].x.requestbin.com",
    "event": "batch",
    "headers": [ … ]
  }
]

Create a webhook

Request

Create a webook for specific events in the environment.

Bodyapplication/jsonrequired
eventstring(webhook_event)required

The possible webook event values

Enum"batch""carrier_connected""order_source_refresh_complete""rate""report_complete""sales_orders_imported""track"
urlstring(url)(url)non-emptyrequired

A URL

Example: "http://api.shipstation.com/v2/labels/se-28529731"
headersArray of objects(webhook_header)

Array of custom webhook headers

curl -i -X POST \
  https://docs.shipstation.com/_mock/openapi/v2/environment/webhooks \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "event": "batch",
    "url": "https://[YOUR ENDPOINT ID].x.requestbin.com",
    "headers": [
      {
        "key": "custom-key",
        "value": "custom-value"
      }
    ]
  }'

Responses

The request was a success.

Bodyapplication/json
webhook_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$read-onlyrequired

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

Example: "se-28529731"
urlstring(url)(url)non-emptyrequired

A URL

Example: "http://api.shipstation.com/v2/labels/se-28529731"
eventstring(webhook_event)required

The possible webook event values

Enum"batch""carrier_connected""order_source_refresh_complete""rate""report_complete""sales_orders_imported""track"
headersArray of objects(webhook_header)

Array of custom webhook headers

Response
application/json
{
  "webhook_id": "se-28529731",
  "url": "https://[YOUR ENDPOINT ID].x.requestbin.com",
  "event": "batch",
  "headers": [
    { … }
  ]
}

Get webhook by id

Request

Retrieve individual webhook by an ID

Path
webhook_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$required

Webhook ID

Example: se-28529731
curl -i -X GET \
  'https://docs.shipstation.com/_mock/openapi/v2/environment/webhooks/{webhook_id}' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

The request was a success.

Bodyapplication/json
webhook_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$read-onlyrequired

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

Example: "se-28529731"
urlstring(url)(url)non-emptyrequired

A URL

Example: "http://api.shipstation.com/v2/labels/se-28529731"
eventstring(webhook_event)required

The possible webook event values

Enum"batch""carrier_connected""order_source_refresh_complete""rate""report_complete""sales_orders_imported""track"
headersArray of objects(webhook_header)

Array of custom webhook headers

Response
application/json
{
  "webhook_id": "se-28529731",
  "url": "https://[YOUR ENDPOINT ID].x.requestbin.com",
  "event": "batch",
  "headers": [
    { … }
  ]
}

Update a webhook

Request

Update the webhook url property

Path
webhook_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$required

Webhook ID

Example: se-28529731
Bodyapplication/jsonrequired
urlstring(url)(url)non-empty

A URL

Example: "http://api.shipstation.com/v2/labels/se-28529731"
headersArray of objects(webhook_header)

Array of custom webhook headers

curl -i -X PUT \
  'https://docs.shipstation.com/_mock/openapi/v2/environment/webhooks/{webhook_id}' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "url": "https://[YOUR ENDPOINT ID].x.requestbin.com",
    "headers": [
      {
        "key": "custom-key",
        "value": "custom-value"
      }
    ]
  }'

Responses

The request was successful.

Body
string(empty_response_body)<= 0 characters
Response
No response example

Delete webhook by id

Request

Delete a webhook

Path
webhook_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$required

Webhook ID

Example: se-28529731
curl -i -X DELETE \
  'https://docs.shipstation.com/_mock/openapi/v2/environment/webhooks/{webhook_id}' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

The request was successful.

Body
string(empty_response_body)<= 0 characters
Response
No response example