Dispute webhooks

Update a dispute webhook

Changed on

Updates the specified dispute webhook. The request replaces the whole object: send both url and header; omitting header removes it. The same URL rules as on registration apply (normalised, unique per merchant).

put/api/v1/dispute-webhooks/{id}

Request

  • Base URL
    https://api.tabby.ai
  • URL
    https://api.tabby.ai/api/v1/dispute-webhooks/{id}
  • Auth
    HTTP bearer

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

Merchant code the request is scoped to. Required on every dispute-webhook request, even when your secret key maps to a single merchant; case-insensitive.

Request body

urlstring uri required

Endpoint for dispute notifications (HTTPS recommended). Must be an absolute URL with a publicly resolvable host name — localhost, raw IP addresses and hosts that do not resolve are rejected. Normalised before it is stored (lower-case scheme and host, default port and trailing slash removed) and unique per merchant.

Example request

{
  "url": "https://example.com/tabby/dispute-webhook",
  "header": {
    "title": "X-Auth-Key",
    "value": "your_random_signing_secret"
  }
}

Response

Success. Dispute webhook object is returned; header.value is masked.

idstring required

Unique dispute webhook ID, assigned by Tabby.

urlstring uri required

Endpoint for dispute notifications, as stored (normalised).

Example response

{
  "id": "f5eb7c26-b163-4fad-b75f-66024824116e",
  "url": "https://example.com/tabby/dispute-webhook",
  "header": {
    "title": "X-Auth-Key",
    "value": "****cret"
  }
}

Changes