API ReferenceWebhooks

Create a new webhook subscription

View as Markdown

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Headers

shipbob_channel_idstringOptionalformat: "int32"

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 or null
Timestamp the webhook subscription was created
idinteger or null
ID of the webhook subscription
subscription_urlstring or nullformat: "uri"
URL subscription events will be posted to
topicenum or null
Allowed values:

Errors