Skip to main content
POST
/
api
/
v1
/
webhooks
Register a webhook
curl --request POST \
  --url https://api.tabby.ai/api/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Merchant-Code: <x-merchant-code>' \
  --data '
{
  "url": "https://example.com/",
  "header": {
    "title": "Arbitrary header name to sign the request",
    "value": "Random string to sign the request"
  }
}
'
{
  "is_test": false,
  "url": "https://example.com/",
  "header": {
    "title": "Arbitrary header name to sign the request",
    "value": "Random string to sign the request"
  },
  "id": "unique webhook id"
}

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
​
id
string
read-only

Unique webhook ID, assigned by Tabby.

Example:

"unique webhook id"