Reference

The Reference section is the concise technical contract for Convosite's developer-facing schemas and runtime events.

Use the guides when you are learning a workflow. Use these pages when you already know what you want to build and need to check an exact property, field type, validation rule or event shape.

Reference pages

• Block Schema — the structure of a block.json definition.
• Endpoint Schema — the structure of an endpoint.json definition, including actions.
• Field Types — every field type currently supported by Blocks and Endpoints.
• Validation Rules — the rules available for each field type.
• Conversation Events — events yielded by @convosite/client while a conversation response streams.

Beta reference

This reference describes the current beta contract. Keep Block and Endpoint definitions in source control so changes to the contract can be reviewed alongside your application code.