Skip to main content
When you create a subscription, you choose which event types it receives. This page describes the available events and the shape of their payloads.

Event types

Events are grouped the same way as in the event picker: Tests, Projects, and Governance.

Tests

Projects

Governance

Project and governance events are not sent for sample projects. Edits to the workspace intake form, risk template, or lifecycle definition do not have events of their own.

Payload structure

Every webhook request body shares the same envelope:
Alongside the body, every request carries signature headers (webhook-id, webhook-timestamp, and webhook-signature). Always verify the signature before trusting a payload.

test.created

Sent when a test is created. The data.test object contains the full test definition.

test.updated

Sent when a test’s configuration changes. The data.test object has the same structure as test.created, reflecting the test’s new state.

test.deleted

Sent when a test is deleted. To keep the payload meaningful after deletion, only the test id is included.

tests.result.updated

Sent once per test suite run, after the suite finishes evaluating. Rather than one event per test, Openlayer emits a single event that summarizes the run. This is the event to subscribe to if you want to alert when tests start failing.

Project and governance events

Every project.* event carries the project’s full current state in data.project, plus the ID of the user who made the change in data.actorId. Because each delivery contains the whole record, you can update your copy of the project from any single event, regardless of which events came before it.
Payload size grows with the number and length of the project’s intake answers. Make sure your endpoint does not reject large request bodies. Some events add a key next to project that describes the change.

project.created

Sent when a project is created, in the app or by an integration. If creation fails, no event is sent.

project.updated

Sent when a project’s name, description, owner, or tags change. data.changes lists each changed project field with its previous and new value. Saving a project without changing anything sends no event.

project.deleted and project.restored

Unlike test.deleted, project.deleted carries the full project, with dateDeleted set. project.restored is sent when a deleted project is restored, with dateDeleted back to null.

project.intake.updated

Sent when a project’s intake answers change. data.intake.changedFieldIds lists the IDs of the fields that were saved; the answers themselves are in data.project.intake.

project.risk.assessed

Sent when a risk assessment is submitted. The resulting level and scores are in data.project.risk.

project.risk_exception.updated

Sent when an admin sets or revokes a risk exception on a dimension. data.riskException.action is set or revoked; note is included only when the exception is set.

project.lifecycle.changed

Sent when a project moves between lifecycle stages. data.lifecycle describes the move:
reason holds the note given for the move, or null. Removing a stage from the workspace lifecycle moves the projects in it to another stage, and each moved project sends project.lifecycle.changed with a reason that names the removed stage.

project.lifecycle.approved

Sent when a reviewer approves the project’s current stage. data.approval names the approved stage and includes the reviewer’s note, if any.
When the approval is the last one the stage needs, the project advances and Openlayer sends project.lifecycle.approved first, followed by project.lifecycle.changed.

Sync an external inventory

To mirror your Openlayer projects in another system, such as a GRC tool or an internal AI inventory:
  • Upsert by project ID. On every project.* event, write data.project to the record keyed by data.project.id. You don’t need to apply changes incrementally.
  • Tolerate out-of-order delivery. Because of retries, an older event can arrive after a newer one. Store the timestamp of the last event you applied for each project and skip events with an earlier timestamp.
  • Deduplicate. Use the webhook-id header to ignore redelivered events.
  • Handle deletion. Treat project.deleted as a soft delete, since the project can still be restored.
Payloads include identifiers rather than every related object. When you need more detail than the payload provides, call the REST API with the IDs from the event.