GET
/
webhook
curl --request GET \
  --url https://api.shipbob.com/1.0/webhook \
  --header 'Authorization: <api-key>'
[
  {
    "created_at": "2019-08-24T14:15:22Z",
    "id": 12345,
    "subscription_url": "http://example.com",
    "topic": "order_shipped"
  }
]

Authorizations

​
Authorization
string
header
required

Provide your personal access token in the format 'Bearer {your_personal_access_token}'

Query Parameters

​
Topic
string

Topic of the webhooks requested

​
Page
number

Page of Webhooks to get

Required range: 0 <= x <= 2147483647
​
Limit
number

Amount of Webhooks per page to request

Required range: 1 <= x <= 250

Response

200
application/json
Success
​
created_at
string

Timestamp the webhook subscription was created

​
id
integer

ID of the webhook subscription

Example:

12345

​
subscription_url
string | null

URL subscription events will be posted to

​
topic
enum<string>
Available options:
order_shipped,
shipment_delivered,
shipment_exception,
shipment_onhold,
shipment_cancelled

Was this page helpful?