webhooks

Register a scan webhook endpoint

Registers an HTTPS endpoint that receives a POST for every scan of your organization's codes (see the scan webhook definition). The response contains signing_secret exactly once — store it to verify the X-QRTap-Signature header on deliveries.

post/api/v1/webhooks

Request

  • Base URL: https://app.qrtap.kg
  • URL: https://app.qrtap.kg/api/v1/webhooks
  • Auth: HTTP bearer

Request body

urlstring uri required

Delivery URL. Must be https://.

Response

Endpoint registered. signing_secret is shown only in this response.

idstring uuid required
urlstring uri required
activeboolean required
signing_secretstring required

whsec_-prefixed secret for verifying X-QRTap-Signature. Shown only once.

created_atstring date-time required

Changes

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