webhooks

Create a webhook subscription

Registers a callback URL to receive events for the selected resources under one product. Requires an x-signature request signature, see request signing.

post/webhooks

Request

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

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
productstring required
resourcesstring[] required
statusstring

Current status of the resource.

urlstring required

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.