PlanetScale sends HTTP POST requests to your configured webhook URL when subscribed events occur. All requests include an X-PlanetScale-Signature header for payload verification.
Triggered when a database branch has been created and is ready to accept connections.
Content-Type: application/json
branch.sleeping
Triggered when a database branch transitions to a sleeping state due to inactivity.
Content-Type: application/json
branch.anomaly
Triggered when a branch has a new anomaly event detected by PlanetScale Insights, such as unusual query performance or resource usage.
Content-Type: application/json
branch.start_maintenance
Triggered right before maintenance for a production branch is about to start, providing advance notice for preparation.
Content-Type: application/json
branch.out_of_memory
Triggered when a Postgres database branch experiences an out of memory event and has to restart. Only applies to Postgres databases.
Content-Type: application/json
deploy_request.opened
Triggered when a new deploy request has been opened for a database.
Content-Type: application/json
deploy_request.queued
Triggered when a deploy request has been queued for deployment.
Content-Type: application/json
deploy_request.in_progress
Triggered when a deploy request deployment is actively in progress.
Content-Type: application/json
deploy_request.schema_applied
Triggered when a deploy request has successfully applied schema changes to the target branch.
Content-Type: application/json
deploy_request.errored
Triggered when a deploy request deployment has encountered an error.
Content-Type: application/json
deploy_request.reverted
Triggered when a deployed schema change has been reverted to the previous state.
Content-Type: application/json
deploy_request.closed
Triggered when a deploy request has been closed without deploying.
Content-Type: application/json
webhook.test
Triggered when a webhook is tested from the PlanetScale dashboard to verify the endpoint is receiving events correctly.
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.