webhooks

Create Webhook

Register a webhook URL. The signing secret is returned once — store it to verify X-Tru8-Signature headers on incoming payloads.

post/api/v1/webhooks

Request

  • Base URL: https://api.trueight.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.trueight.com/api/v1/webhooks
  • Auth: none declared

Request body

urlstring required

HTTPS URL to receive events

eventsstring[] required

Events to subscribe to

descriptionstring nullable

Label for this webhook

Response

Successful Response

idstring required

Webhook database ID

urlstring required

HTTPS URL that will receive events

eventsstring[] required

Events this webhook is subscribed to (e.g. check.completed, check.failed)

secretstring required

HMAC signing secret (shown once). Use to verify X-Tru8-Signature headers on incoming payloads.

descriptionstring nullable

Webhook label

created_atstring date-time required

Creation timestamp

Changes

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