VRPlatformVRPlatform

Webhook Catalog

Generated event, version, scope, resource, and status values

Webhook Catalog

See Webhooks for signature verification and delivery semantics.

Subscription Events

  • team.issues.changed
  • connection.changed
  • sync.status.changed
  • reservation.changed
  • listing.changed
  • statement.status.changed
  • transaction.changed

Only subscription events can be selected in a webhook subscription.

Delivery Events

  • webhook.test
  • team.issues.changed
  • connection.changed
  • sync.status.changed
  • reservation.changed
  • listing.changed
  • statement.status.changed
  • transaction.changed

Delivery-only events such as webhook.test can appear in delivery history without being subscribable.

Event Contracts

Every event is a compact invalidation. Fetch its relative href, when present, with an authenticated API request to reconcile current state. The envelope and data examples below are generated from the runtime registry.

webhook.test

Verifies a receiver after it has stored the signing secret.

Subscribable

No; this event is delivery-only.

Resource type

webhook

Source version

Unique test delivery ID

Emission boundary

Explicit test request only

Data fields

  • webhookId: Subscription being verified.

Example

{
  "id": "018f9c2b-7f4b-7d72-bf2e-9ab983f07018",
  "type": "webhook.test",
  "apiVersion": "2026-07-01",
  "createdAt": "2026-07-17T12:00:00.000+00:00",
  "teamId": null,
  "data": {
    "webhookId": "edb0c159-9ad4-49e8-9999-31069a8669bf"
  }
}

team.issues.changed

Invalidates the materialized open-issue snapshot for a team.

Subscribable

Yes

Resource type

team

Source version

Monotonic health.tenantIssueSnapshot.version

Emission boundary

Issue evaluation transaction after a normalized snapshot change

Data fields

  • snapshotVersion: Monotonic version of the complete team issue snapshot.
  • changedCodes: Issue codes opened, changed, resolved, or reopened in this version.
  • href: Relative endpoint for the current complete open-issue snapshot.

Example

{
  "id": "018f9c2b-7f4b-7d72-bf2e-9ab983f07018",
  "type": "team.issues.changed",
  "apiVersion": "2026-07-01",
  "createdAt": "2026-07-17T12:00:00.000+00:00",
  "teamId": "61d87dad-91fe-44be-90bf-fe27b637f860",
  "data": {
    "snapshotVersion": 42,
    "changedCodes": [
      "brokenConnections"
    ],
    "href": "/teams/issues?teamIds=61d87dad-91fe-44be-90bf-fe27b637f860"
  }
}

connection.changed

Invalidates a public connection after a material create, update, or delete.

Subscribable

Yes

Resource type

connection

Source version

Monotonic connection.webhookVersion

Emission boundary

Committed public connection mutation; credential-only changes do not emit

Data fields

  • resourceId: Canonical public resource ID.
  • changeType: One of created, updated, or deleted.
  • resourceVersion: Monotonic version for this resource.
  • href: Relative reconciliation endpoint; a deleted resource may return 404.

Example

{
  "id": "018f9c2b-7f4b-7d72-bf2e-9ab983f07018",
  "type": "connection.changed",
  "apiVersion": "2026-07-01",
  "createdAt": "2026-07-17T12:00:00.000+00:00",
  "teamId": "61d87dad-91fe-44be-90bf-fe27b637f860",
  "data": {
    "resourceId": "b5816213-b1b7-46a6-a3a7-1ec1c44d00d9",
    "changeType": "updated",
    "resourceVersion": 7,
    "href": "/connections/b5816213-b1b7-46a6-a3a7-1ec1c44d00d9"
  }
}

sync.status.changed

Reports an actual synchronization status transition.

Subscribable

Yes

Resource type

sync

Source version

Monotonic core.sync.webhookVersion

Emission boundary

Committed sync status transition; subtask-only changes do not emit

Data fields

  • resourceId: Canonical sync ID.
  • connectionId: Related connection ID when the sync has one.
  • previousStatus: Previous status, or null for the initial queued event.
  • status: Current sync status.
  • resourceVersion: Monotonic version for this sync.
  • href: Relative reconciliation endpoint for the sync.

Example

{
  "id": "018f9c2b-7f4b-7d72-bf2e-9ab983f07018",
  "type": "sync.status.changed",
  "apiVersion": "2026-07-01",
  "createdAt": "2026-07-17T12:00:00.000+00:00",
  "teamId": "61d87dad-91fe-44be-90bf-fe27b637f860",
  "data": {
    "resourceId": "98cab320-926a-49c6-bca2-41de4ea56711",
    "connectionId": "2ea79c4b-6bc4-4be2-98b6-190b12045a12",
    "previousStatus": "started",
    "status": "completed",
    "resourceVersion": 3,
    "href": "/syncs/98cab320-926a-49c6-bca2-41de4ea56711"
  }
}

reservation.changed

Invalidates a canonical reservation aggregate after a public change.

Subscribable

Yes

Resource type

reservation

Source version

Monotonic reservation.webhookVersion

Emission boundary

Final reservation journal and payment effect when required

Data fields

  • resourceId: Canonical public resource ID.
  • changeType: One of created, updated, or deleted.
  • resourceVersion: Monotonic version for this resource.
  • href: Relative reconciliation endpoint; a deleted resource may return 404.

Example

{
  "id": "018f9c2b-7f4b-7d72-bf2e-9ab983f07018",
  "type": "reservation.changed",
  "apiVersion": "2026-07-01",
  "createdAt": "2026-07-17T12:00:00.000+00:00",
  "teamId": "61d87dad-91fe-44be-90bf-fe27b637f860",
  "data": {
    "resourceId": "b5816213-b1b7-46a6-a3a7-1ec1c44d00d9",
    "changeType": "updated",
    "resourceVersion": 7,
    "href": "/reservations/b5816213-b1b7-46a6-a3a7-1ec1c44d00d9"
  }
}

listing.changed

Invalidates a canonical listing after a public or hierarchy change.

Subscribable

Yes

Resource type

listing

Source version

Monotonic listing.webhookVersion

Emission boundary

Committed listing mutation; batch producers match and insert set-wise

Data fields

  • resourceId: Canonical public resource ID.
  • changeType: One of created, updated, or deleted.
  • resourceVersion: Monotonic version for this resource.
  • href: Relative reconciliation endpoint; a deleted resource may return 404.

Example

{
  "id": "018f9c2b-7f4b-7d72-bf2e-9ab983f07018",
  "type": "listing.changed",
  "apiVersion": "2026-07-01",
  "createdAt": "2026-07-17T12:00:00.000+00:00",
  "teamId": "61d87dad-91fe-44be-90bf-fe27b637f860",
  "data": {
    "resourceId": "b5816213-b1b7-46a6-a3a7-1ec1c44d00d9",
    "changeType": "updated",
    "resourceVersion": 7,
    "href": "/listings/b5816213-b1b7-46a6-a3a7-1ec1c44d00d9"
  }
}

statement.status.changed

Reports a persisted owner-statement status transition.

Subscribable

Yes

Resource type

statement

Source version

Monotonic public.ownerStatement.webhookVersion

Emission boundary

Persisted status transition only; draft projections do not emit

Data fields

  • resourceId: Canonical owner-statement ID.
  • previousStatus: Previous persisted status, or null when first persisted.
  • status: Current persisted status, or null for a deletion tombstone.
  • resourceVersion: Monotonic version for this owner statement.
  • href: Relative reconciliation endpoint for the owner statement.

Example

{
  "id": "018f9c2b-7f4b-7d72-bf2e-9ab983f07018",
  "type": "statement.status.changed",
  "apiVersion": "2026-07-01",
  "createdAt": "2026-07-17T12:00:00.000+00:00",
  "teamId": "61d87dad-91fe-44be-90bf-fe27b637f860",
  "data": {
    "resourceId": "a349dd21-883e-46e9-93a6-34e29652c432",
    "previousStatus": "inReview",
    "status": "published",
    "resourceVersion": 2,
    "href": "/statements/a349dd21-883e-46e9-93a6-34e29652c432"
  }
}

transaction.changed

Invalidates the permission- and lock-aware public transaction aggregate.

Subscribable

Yes

Resource type

transaction

Source version

Monotonic transaction.webhookVersion

Emission boundary

Final journal, payment, reconciliation, or attachment effect when required

Data fields

  • resourceId: Canonical public resource ID.
  • changeType: One of created, updated, or deleted.
  • resourceVersion: Monotonic version for this resource.
  • href: Relative reconciliation endpoint; a deleted resource may return 404.

Example

{
  "id": "018f9c2b-7f4b-7d72-bf2e-9ab983f07018",
  "type": "transaction.changed",
  "apiVersion": "2026-07-01",
  "createdAt": "2026-07-17T12:00:00.000+00:00",
  "teamId": "61d87dad-91fe-44be-90bf-fe27b637f860",
  "data": {
    "resourceId": "b5816213-b1b7-46a6-a3a7-1ec1c44d00d9",
    "changeType": "updated",
    "resourceVersion": 7,
    "href": "/transactions/b5816213-b1b7-46a6-a3a7-1ec1c44d00d9"
  }
}

API Version

  • 2026-07-01

Subscription Scopes

  • self
  • managedTeams

Subscription States

  • pending
  • active
  • disabled

Delivery States

  • queued
  • delivering
  • retrying
  • succeeded
  • failed
  • canceled

Resource Types

  • webhook
  • team
  • connection
  • sync
  • reservation
  • listing
  • statement
  • transaction

Use Keep your UI synchronized for the full issues and webhook reconciliation algorithm.

On this page