Skip to main content
POST
Register a webhook

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <secret_key>, where <secret_key> is your secret_key.

Headers

X-Merchant-Code
string
required

Used for multi store/countries setup, please contact your Account manager to recognize that

Example:

"code provided to you from Tabby side"

Body

application/json
url
string<uri>
required

HTTPS endpoint for notifications. The URL should be valid and accessible (not local).

Example:

"https://example.com/"

header
object

Response

Success. Webhook object is returned.

is_test
boolean
default:false
required
deprecated

Deprecated. The webhook environment is determined by the secret key used at registration (production sk_... or test sk_test_...), not by this field.

url
string<uri>
required

HTTPS endpoint for notifications. The URL should be valid and accessible (not local).

Example:

"https://example.com/"

header
object | null
id
string
read-only

Unique webhook ID, assigned by Tabby.

Example:

"unique webhook id"