Webhooks

Update a webhook

Changed on

Updates the specified webhook.

put/api/v1/webhooks/{id}

Request

  • Base URL
    https://api.tabby.ai
  • URL
    https://api.tabby.ai/api/v1/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

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

Request body

idstring required

Unique webhook ID, assigned by Tabby.

urlstring uri required

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

Example request

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

Response

Success. Webhook object is returned.

idstring required

Unique webhook ID, assigned by Tabby.

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-updated.com/"
}

Changes

    • breaking

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

    • info

      removed the non-success 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

    • info

      added the optional property to the response with the status