v1

latestOpenAPI 3.1.02026-07-131991131.4 KB
Webhooks

Retrieve a webhook

Retrieves the specified webhook.

get/api/v1/webhooks/{id}

Path parameters

idstring uuid required
Example:webhook id, uuid format

ID of the webhook.

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

Response

Success. Webhook object is returned.

idstring required

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/"
}