List Webhooks

We can list the active web hooks by making a GET call to the v1/environment/webhooks endpoint.

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 web hook if you append the webhook_id to the end of the endpoint.

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"
  }
]