Skip to main content
POST
/
2025-07
/
webhook
Create Subscription 
curl --request POST \
  --url https://api.shipbob.com/2025-07/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "string",
  "secret": "string",
  "topics": [
    "string"
  ],
  "url": "https://mywebsite.com/shipbob/handler"
}
'
{
  "created_at": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "12345",
  "secret": "string",
  "topics": [
    "string"
  ],
  "url": "string"
}

Authorizations

​
Authorization
string
header
required

Authentication using Personal Access Token (PAT) token

Body

application/json
​
topics
enum<string>[]
required

The event types for which webhook callbacks will be received.

Available options:
order.shipped,
order.shipment.delivered,
order.shipment.exception,
order.shipment.on_hold,
order.shipment.cancelled
​
url
string<uri>
required

The URL that will be called when an event matching the subscription topic occurs. The URL must use HTTPS, accept POST requests, and handle content of type application/json.

Example:

"https://mywebsite.com/shipbob/handler"

​
description
string | null

Description of the webhook subscription.

​
secret
string | null

A secret key used to sign the webhook payload for verifying its authenticity on the receiver's end.

Response

Success

​
created_at
string<date-time>

TimeStamp the webhook subscription was created

​
description
string | null

Description of the webhook subscription

​
id
string

ID of the webhook subscription

Example:

"12345"

​
secret
string

A secret key used to sign the webhook payload for verifying its authenticity on the receiver's end.

​
topics
enum<string>[]

List of event types the webhook will receive notifications for

Available options:
order.shipped,
order.shipment.delivered,
order.shipment.exception,
order.shipment.on_hold,
order.shipment.cancelled
​
url
string

URL subscription events will be posted to