webhooks

Update a webhook subscription

Updates the callback URL, description, product, resources, or Active/Inactive status. Requires an x-signature request signature, see request signing.

patch/webhooks/{webhookId}

Request

  • Base URL: https://api.sandbox.tryspare.ae
  • URL: https://api.sandbox.tryspare.ae/webhooks/{webhookId}
  • Auth: HTTP bearer

Path parameters

webhookIdstring required

UUID of the webhook subscription.

Headers

x-signaturestring required

ES256 request signature. Required on signed-write endpoints, see request signing.

x-tenantstring required
Example:UAE

Regulatory jurisdiction the request routes to (e.g. UAE, KSA, MAIN). Match it to the market you're integrating.

Request body

descriptionstring nullable
productstring
resourcesstring[]
statusstring

Current status of the resource.

urlstring

Response

Success response

Example response

{
  "data": {
    "createdAt": "2025-01-01T00:00:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.