Skip to main content

Register source of building block run

POST 
/api/meshobjects/meshbuildingblockruns/:uuid/status/source

Attention: This API is currently in BETA and subject to change.

In order to return updates for a run to meshStack, you first need to register one or multiple steps and their resources of your run execution. It is up to you how many or how you organize your steps. You can however also just send step results back and the registration takes place on the fly, but in order to have a consistent display and ordering of steps, it is highly advised to pre-register steps and sources.

Services which are called block runner are responsible for executing block runs. Those services use this API to execute and update the run status in meshStack. At the moment it is not possible to create and integrate a fully custom block runner, however you can use this API to send back status updates of individual block runs when you build an asynchronous building block (this is a building block which gets its execution handed over to an external system by the block runner). You need an API key with the permission to update building block runs. Please be aware that you can only update runs whose underlying building block definitions are owned by the workspace the API key is scoped to.

Request​

Responses​

Source registered