Webhooks

Webhooks to receive API notifications upon certain events in Ketryx

Webhooks can be used to receive programmatic notifications upon certain events in Ketryx.

Webhooks are configured via the advanced setting Webhooks. The following events are supported:

• recordApproval: Approval of an item record

• releaseApproval: Approval of a version/release

• milestoneApproval: Approval of a milestone

• documentApproval: Approval of a document in the EDMS

• testPlanApproval: Approval of a release test plan

• vulnerabilityApproval: Approval of a vulnerability

Each event can be configured to trigger a webhook call via an HTTP POST or GET request. When using a POST request (the default), a JSON payload will be sent with the request, containing the following data:

Event	Fields in JSON payload
recordApproval	userId, itemId, recordId, isControlled, newRecordId
documentApproval	userId, itemId, recordId, isControlled, newRecordId
vulnerabilityApproval	userId, itemId, recordId, isControlled, newRecordId
releaseApproval	userId, versionId, isReleased, releaseDate
milestoneApproval	userId, milestoneId, isFullyApproved
testPlanApproval	userId, versionId, testPlanId

All IDs are specified as Ketryx ID strings (e.g., KXREC1N91YGN3JB8PVT4DDFVF4Y64YT).

Note that webhooks are also triggered for partial approvals, i.e., any time a user makes an approval, even if the approved object is not fully approved yet. To distinguish fully approved objects, use fields such as isControlled, isReleased, and isFullyApproved. If the approval resulted in a new (controlled) record, that record will be indicated by the field newRecordId.

Webhooks are delivered asynchronously. The result of webhook calls can be inspected in a project's History > System logs.