Get Webhooks

curl --request GET \
  --url https://api.shipbob.com/2.0/webhook \
  --header 'Authorization: Bearer <token>'

[
  {
    "created_at": "2019-08-24T14:15:22Z",
    "id": 12345,
    "subscription_url": "http://example.com",
    "topic": "order_shipped"
  }
]

GET

2.0

webhook

Get Webhooks

curl --request GET \
  --url https://api.shipbob.com/2.0/webhook \
  --header 'Authorization: Bearer <token>'

[
  {
    "created_at": "2019-08-24T14:15:22Z",
    "id": 12345,
    "subscription_url": "http://example.com",
    "topic": "order_shipped"
  }
]

Use the Webhooks Resource to create, view or delete subscriptions for a user.

Authorization

string

header

required

Authentication using Personal Access Token (PAT) token

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

Success

created_at

string<date-time>

Timestamp the webhook subscription was created

integer

ID of the webhook subscription

Example:

12345

subscription_url

string<uri> | null

URL subscription events will be posted to

topic

enum<string>

Available options:

order_shipped,

shipment_delivered,

shipment_exception,

shipment_onhold,

shipment_cancelled