Skip to main content

Developer Docs

Interact with Alloy's API

Alloy is designed with developers in mind and provides a comprehensive, public-facing API for you to interact with.

Everything that can be done in Alloy Web can be done programmatically. This makes it possible to create custom integrations for your organisation that can exchange data with Alloy and even issue commands.

Plus, new features often come to the API first, giving you the chance to use them before everyone else! 🤫

Blueprints

Blueprints are how we define the data structure of the objects provided with Alloy, e.g. designs, interfaces, layers, workflows.

They're grouped into modules, with all customer projects having the Core modules installed by default. Other modules are installed according to your organisation's needs.

All blueprints are documented here for reference. You can see what each module contains, browse the blueprints by type, or search for an object's code, e.g. designs_taskStatusTypes.