TAtabby
Webhooks

Register a webhook

Changed on

Creates a new webhook. Webhooks are registered per merchant_code and per environment: the environment is determined by the secret key you authorize the request with — a production key (sk_...) registers webhooks for production payments, a test key (sk_test_...) registers webhooks for test payments. Each merchant_code + key pair can have up to 4 webhooks.

post/api/v1/webhooks

Request

  • Base URL
    https://api.tabby.ai
  • URL
    https://api.tabby.ai/api/v1/webhooks
  • Auth
    HTTP bearer

Headers

X-Merchant-Codestring required
Example:code provided to you from Tabby side

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

Request body

urlstring uri required

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

Example request

{
  "url": "https://example.com/",
  "header": {
    "title": "Arbitrary header name to sign the request",
    "value": "Random string to sign the request"
  }
}

Response

Success. Webhook object is returned.

idstring

Unique webhook ID, assigned by Tabby.

is_testboolean required

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

urlstring uri required

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

Example response

{
  "header": {
    "title": "Arbitrary header name to sign the request",
    "value": "Random string to sign the request"
  },
  "id": "unique webhook id",
  "url": "https://example.com/"
}

Changes

  • cff62a2a6ee9Revision changes
    • breaking

      the response's body type changed from string to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status