Backstage · AsyncAPI Specification

Backstage Events System

Version 1.0.0

The Backstage Events system provides a publish-subscribe mechanism for broadcasting and consuming events within a Backstage instance. It enables plugins to emit events when significant actions occur (such as catalog entity changes, scaffolder task completions, or permission policy updates) and allows other plugins or external systems to subscribe to those events via HTTP webhooks or the internal event bus.

View Spec View on GitHub Developer PortalInternal Developer PlatformSoftware CatalogOpen SourceAsyncAPIWebhooksEvents

Channels

catalogEntityChange

Events emitted when catalog entities are created, updated, or deleted. These events are triggered by catalog processors and entity providers when the state of the software catalog changes.

catalogLocationChange

Events emitted when catalog locations are added, updated, or removed.

scaffolderTaskComplete

Events emitted when a scaffolder task changes status, including creation, completion, or failure.

techdocsBuild

Events emitted when TechDocs documentation is built or updated.

Messages

✉

CatalogEntityChangeEvent

Catalog Entity Change Event

✉

CatalogLocationChangeEvent

Catalog Location Change Event

✉

ScaffolderTaskEvent

Scaffolder Task Event

✉

TechDocsBuildEvent

TechDocs Build Event