Create a new webhook subscription | ShipBob Developer API

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Request

This endpoint expects an object.

subscription_urlstringRequiredformat: "uri"

URL we will call when an event matching the subscription topic is raised. Must have ssl enabled (https) and accept POST requests with content type of application/json

topicenumRequired

Allowed values:

Response

Success

created_atdatetime

Timestamp the webhook subscription was created

idinteger

ID of the webhook subscription

subscription_urlstring or nullformat: "uri"

URL subscription events will be posted to

topicenum

Allowed values:

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

1	import requests
2
3	url = "https://api.shipbob.com/2.0/webhook"
4
5	payload = {
6	"subscription_url": "https://mywebsite.com/shipbob/handler",
7	"topic": "order_shipped"
8	}
9	headers = {
10	"Authorization": "Bearer <token>",
11	"Content-Type": "application/json"
12	}
13
14	response = requests.post(url, json=payload, headers=headers)
15
16	print(response.json())

1	{
2	"created_at": "2019-08-24T14:15:22Z",
3	"id": 12345,
4	"subscription_url": "http://example.com",
5	"topic": "order_shipped"
6	}

Authentication

Headers

Request

Response

Errors