Onshape · AsyncAPI Specification

Onshape Events Webhooks

Version

View Spec View on GitHub CompanyCADPLMProduct Data ManagementEngineeringManufacturingDesignCloudDeveloper ToolsAsyncAPIEvents

AsyncAPI Specification

Raw ↑
generated: '2026-07-20'
method: searched
source: https://onshape-public.github.io/docs/app-dev/webhook/
type: Webhooks
docs: https://onshape-public.github.io/docs/app-dev/webhook/
transport: HTTP POST (JSON body) to a subscriber-provided HTTPS URL (CA-signed certs required)
registration:
  operation: createWebhook
  endpoint: POST /webhooks
  validation: Onshape sends a trial `webhook.register` notification to confirm reachability.
  dedup: No deduplication — each registration returns a new webhook ID.
  scopes: [webhook.create, webhook.read, webhook.edit, webhook.delete]
payload_fields: [timestamp, event, webhookId, messageId, documentId, workspaceId, elementId, data]
events:
  application:
    - onshape.user.lifecycle.updateappsettings
  document:
    - onshape.comment.create
    - onshape.comment.delete
    - onshape.comment.update
    - onshape.document.lifecycle.created
    - onshape.document.lifecycle.shared
    - onshape.document.lifecycle.statechange
    - onshape.model.lifecycle.changed
    - onshape.model.lifecycle.changed.externalreferences
    - onshape.model.lifecycle.createelement
    - onshape.model.lifecycle.createversion
    - onshape.model.lifecycle.createworkspace
    - onshape.model.lifecycle.deleteelement
    - onshape.model.lifecycle.metadata
    - onshape.model.translation.complete
    - onshape.revision.created
  workflow:
    - onshape.workflow.transition
  lifecycle:
    - webhook.register
    - webhook.unregister
    - webhook.ping
management_operations:
  - getWebhooks
  - getWebhook
  - updateWebhook
  - unregisterWebhook
  - pingWebhook

Work with this as data

Every AsyncAPI spec here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for asyncapi

4 MCP tools reach this
  • find_asyncapisBrowse and filter every AsyncAPI spec in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This AsyncAPI spec
curl "https://apis.io/api/v1/asyncapis/onshape-events-webhooks"
All asyncapi
curl "https://apis.io/api/v1/asyncapis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.