🎉 ShipEngine is becoming ShipStation API 🎉

Over the next few months you'll notice the ShipEngine website, documentation portal, and dashboard being rebranded as ShipStation API. For our ShipEngine customers, you don't need to take any action or change any of your integrations in any way. All endpoints will remain the same and continue to function as they always have.

To learn more about what's coming, review our New ShipStation API page.

List Webhooks

You can list the active webhooks using the GET method to call to the webhooks endpoint. This method lists only active webhooks.

GET v1/environment/webhooks

1
2
3
GET /v1/environment/webhooks HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

You can also list a specific webhook if you append the webhook_id to the end of the endpoint.

GET v1/environment/webhooks/:webhook_id

1
2
3
GET /v1/environment/webhooks/5517 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

When listing your webhooks, you'll receive a JSON response similar to the following example.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
[
  {
      "webhook_id": "5517",
      "url": "https://www.yourwebhook.com/listener/batch",
      "event": "batch"
  },
  {
      "webhook_id": "5515",
      "url": "https://www.yourwebhook.com/listener/rate",
      "event": "rate"
  },
  {
      "webhook_id": "5516",
      "url": "https://www.yourwebhook.com/listener/track",
      "event": "track"
  }
]