# Create Subscription


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

This endpoint creates a new webhook subscription.


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

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: |
    Create Subscription
  version: endpoint_webhooks.createSubscription
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 or OAuth2
          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: {}
        '403':
          description: No access
          content: {}
        '422':
          description: Client Error
          content: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Webhooks.V2.CreateSubscriptionRequest'
components:
  schemas:
    Webhooks.Topics:
      type: string
      enum:
        - value: order.shipped
        - value: order.shipment.delivered
        - value: order.shipment.exception
        - value: order.shipment.on_hold
        - value: order.shipment.cancelled
        - value: return.created
        - value: return.updated
        - value: return.completed
    Webhooks.V2.CreateSubscriptionRequest:
      type: object
      properties:
        description:
          type:
            - string
            - 'null'
          description: Description of the webhook subscription.
        secret:
          type:
            - string
            - 'null'
          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
    Webhooks.V2.Create.WebhookViewModelV2:
      type: object
      properties:
        created_at:
          type: string
          format: date-time
          description: TimeStamp the webhook subscription was created
        description:
          type:
            - string
            - 'null'
          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

```

## SDK Code Examples

```python Webhooks_createSubscription_example
import requests

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

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

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

print(response.json())
```

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

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

```go Webhooks_createSubscription_example
package main

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

func main() {

	url := "https://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")

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

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

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

}
```

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

url = URI("https://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'
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 Webhooks_createSubscription_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

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

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://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',
  ],
]);

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

```csharp Webhooks_createSubscription_example
using RestSharp;

var client = new RestClient("https://api.shipbob.com/2026-01/webhook");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/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 Webhooks_createSubscription_example
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "topics": ["order.shipped"],
  "url": "https://mywebsite.com/shipbob/handler",
  "description": "string",
  "secret": "string"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://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()
```