Upload webhook schema

Upload a schema (AsyncAPI, JSON Schema, or raw JSON example) for a webhook surface.

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired
Product ID
surfaceIdstringRequired
Surface ID

Request

This endpoint expects an object.
formatenumOptional
Allowed values:
schemaanyOptional

Response

Schema uploaded
learningStatestring
proposedSchemaany

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error