> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer-stage.shipbob.dev/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer-stage.shipbob.dev/_mcp/server.

# Create Subscription


POST https://sandbox-api.shipbob.com/2026-01/webhook
Content-Type: application/json-patch+json

This endpoint creates a new webhook subscription.


Reference: https://developer-stage.shipbob.dev/api/webhooks/create-subscription

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: api-2026-01
  version: 1.0.0
paths:
  /2026-01/webhook:
    post:
      operationId: create-subscription
      summary: |
        Create Subscription
      description: |
        This endpoint creates a new webhook subscription.
      tags:
        - subpackage_webhooks
      parameters:
        - name: Authorization
          in: header
          description: Authentication using Personal Access Token (PAT) token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhooks.V2.Create.WebhookViewModelV2'
        '401':
          description: No access right at this time
          content:
            application/json:
              schema:
                description: Any type
        '403':
          description: No access
          content:
            application/json:
              schema:
                description: Any type
        '422':
          description: Client Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhooks.UnprocessableEntityObjectResult'
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Webhooks.V2.CreateSubscriptionRequest'
servers:
  - url: https://sandbox-api.shipbob.com
    description: https://sandbox-api.shipbob.com
components:
  schemas:
    Webhooks.Topics:
      type: string
      enum:
        - order.shipped
        - order.shipment.delivered
        - order.shipment.exception
        - order.shipment.on_hold
        - order.shipment.cancelled
        - order.shipment.tracking.updated
        - order.shipment.address.updated
        - order.shipment.line_item.added
        - order.shipment.line_item.removed
        - order.shipment.line_item.updated
        - order.shipment.shipping_service.updated
        - return.created
        - return.updated
        - return.completed
        - return.load_shipment.departed
        - return.gaylord.departed
        - return.load_shipment.arrived
        - return.gaylord.arrived
        - billing.charge.created
        - billing.refund.created
        - billing.credit.created
        - wro.box.arrived
        - wro.box.scanned
        - wro.box.stowed
        - wro.completed
        - wro.created
        - wro.updated
      title: Webhooks.Topics
    Webhooks.V2.CreateSubscriptionRequest:
      type: object
      properties:
        description:
          type: string
          description: Description of the webhook subscription.
        secret:
          type: string
          description: >-
            A secret key used to sign the webhook payload for verifying its
            authenticity on the receiver's end.
        topics:
          type: array
          items:
            $ref: '#/components/schemas/Webhooks.Topics'
          description: The event types for which webhook callbacks will be received.
        url:
          type: string
          format: uri
          description: "The URL that will be called when an event matching the subscription topic occurs.\r\nThe URL must use HTTPS, accept POST requests, and handle content of type application/json."
      required:
        - topics
        - url
      title: Webhooks.V2.CreateSubscriptionRequest
    Webhooks.V2.Create.WebhookViewModelV2:
      type: object
      properties:
        created_at:
          type: string
          format: date-time
          description: TimeStamp the webhook subscription was created
        description:
          type: string
          description: Description of the webhook subscription
        id:
          type: string
          description: ID of the webhook subscription
        secret:
          type: string
          description: >-
            A secret key used to sign the webhook payload for verifying its
            authenticity on the receiver's end.
        topics:
          type: array
          items:
            $ref: '#/components/schemas/Webhooks.Topics'
          description: List of event types the webhook will receive notifications for
        url:
          type: string
          description: URL subscription events will be posted to
      title: Webhooks.V2.Create.WebhookViewModelV2
    WebhooksUnprocessableEntityObjectResultValue:
      type: object
      properties: {}
      title: WebhooksUnprocessableEntityObjectResultValue
    Webhooks.UnprocessableEntityObjectResult:
      type: object
      properties:
        content_types:
          type: array
          items:
            type: string
        declared_type:
          description: Any type
        formatters:
          type: array
          items:
            description: Any type
        status_code:
          type: integer
        value:
          $ref: '#/components/schemas/WebhooksUnprocessableEntityObjectResultValue'
      title: Webhooks.UnprocessableEntityObjectResult
  securitySchemes:
    PAT:
      type: http
      scheme: bearer
      description: Authentication using Personal Access Token (PAT) token
    OAuth2:
      type: http
      scheme: bearer
      description: OAuth2 authentication using JWT tokens

```

## Examples



**Request**

```json
{
  "topics": [
    "order.shipped"
  ],
  "url": "https://mywebsite.com/shipbob/handler",
  "description": "string",
  "secret": "string"
}
```

**Response**

```json
{
  "created_at": "2019-08-24T14:15:22+00:00",
  "description": "string",
  "id": "12345",
  "secret": "string",
  "topics": [
    "order.shipped"
  ],
  "url": "string"
}
```

**SDK Code**

```python default
import requests

url = "https://sandbox-api.shipbob.com/2026-01/webhook"

payload = "{\n  \"topics\": [\n    \"order.shipped\"\n  ],\n  \"url\": \"https://mywebsite.com/shipbob/handler\",\n  \"description\": \"string\",\n  \"secret\": \"string\"\n}"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, data=payload, headers=headers)

print(response.json())
```

```javascript default
const url = 'https://sandbox-api.shipbob.com/2026-01/webhook';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: '{\n  "topics": [\n    "order.shipped"\n  ],\n  "url": "https://mywebsite.com/shipbob/handler",\n  "description": "string",\n  "secret": "string"\n}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go default
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.shipbob.com/2026-01/webhook"

	payload := strings.NewReader("{\n  \"topics\": [\n    \"order.shipped\"\n  ],\n  \"url\": \"https://mywebsite.com/shipbob/handler\",\n  \"description\": \"string\",\n  \"secret\": \"string\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby default
require 'uri'
require 'net/http'

url = URI("https://sandbox-api.shipbob.com/2026-01/webhook")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"topics\": [\n    \"order.shipped\"\n  ],\n  \"url\": \"https://mywebsite.com/shipbob/handler\",\n  \"description\": \"string\",\n  \"secret\": \"string\"\n}"

response = http.request(request)
puts response.read_body
```

```java default
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://sandbox-api.shipbob.com/2026-01/webhook")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"topics\": [\n    \"order.shipped\"\n  ],\n  \"url\": \"https://mywebsite.com/shipbob/handler\",\n  \"description\": \"string\",\n  \"secret\": \"string\"\n}")
  .asString();
```

```php default
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://sandbox-api.shipbob.com/2026-01/webhook', [
  'body' => '{
  "topics": [
    "order.shipped"
  ],
  "url": "https://mywebsite.com/shipbob/handler",
  "description": "string",
  "secret": "string"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json-patch+json',
  ],
]);

echo $response->getBody();
```

```csharp default
using RestSharp;

var client = new RestClient("https://sandbox-api.shipbob.com/2026-01/webhook");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json-patch+json");
request.AddParameter("application/json-patch+json", "{\n  \"topics\": [\n    \"order.shipped\"\n  ],\n  \"url\": \"https://mywebsite.com/shipbob/handler\",\n  \"description\": \"string\",\n  \"secret\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift default
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json-patch+json"
]

let postData = NSData(data: "{
  "topics": [
    "order.shipped"
  ],
  "url": "https://mywebsite.com/shipbob/handler",
  "description": "string",
  "secret": "string"
}".data(using: String.Encoding.utf8)!)

let request = NSMutableURLRequest(url: NSURL(string: "https://sandbox-api.shipbob.com/2026-01/webhook")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```