Sign in
webhooks

List webhooks

List all webhooks currently enabled for the account.

get/v2/environment/webhooks

Request

  • Base URL: https://api.shipstation.com
  • URL: https://api.shipstation.com/v2/environment/webhooks
  • Auth: API key in header api-key

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": "http://api.shipstation.com/v2/labels/se-28529731",
    "headers": [
      {
        "key": "custom-key",
        "value": "custom-value"
      }
    ],
    "name": "My Webhook",
    "store_id": 123456
  }
]

Changes

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