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

Response

Success

created_atdatetimeOptional

Timestamp the webhook subscription was created

idintegerOptional

ID of the webhook subscription

subscription_urlstring or nullOptionalformat: "uri"

URL subscription events will be posted to

topicenumOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

$	curl -X POST https://api.shipbob.com/2.0/webhook \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"subscription_url": "https://mywebsite.com/shipbob/handler",
>	"topic": "order_shipped"
>	}'

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