Delivery through REST (POST)

Delivery - REST

Delivery - REST

This URL will be called when the build completes.

When the exporter runs (either successfully or with a potential error), your API will be invoked and sent the following JSON payload through POST:

                                                          "event": "job:updated",
                                                          "workspace": {
                                                            "id": "1",
                                                            "name": "Example workspace"
                                                          "designSystem": {
                                                            "id": "2",
                                                            "name": "Example Design System"
                                                          "designSystemVersion": {
                                                            "id": "3",
                                                            "name": "A version name",
                                                            "version": "v0.1"
                                                          "exporter": {
                                                            "id": "4",
                                                            "name": "Example exporter"
                                                          "hook": {
                                                            "id": "5",
                                                            "name": "Example hook"
                                                          "job": {
                                                            "id": "6",
                                                            "status": "Success",
                                                            "logs": [
                                                                "id": "",
                                                                "time": "2021-03-25T16:13:28.804Z",
                                                                "type": "info",
                                                                "message": "Finished exporting source"
                                                            "urls": [

There are several important pieces to this payload:

Hook Configuration

You will get a complete set of the configuration attributes inside the payload, allowing you to precisely identify which event happened, in which design system, and forward the code wherever you want to.


Job describes the result of the run:

  • id uniquely identifies the job / exporter run inside your workspace
  • status results either to Success or Failure
  • logs give you full log of exporter run, using Pulsar logging engine


If the exporter created code successfully, urls will be provided as well. At this point, there will always be just one link, but we are reserving this option for more flexibility down the road.

The URL links to a secure, signed .zip file that can only be accessed with the URL provided in the payload, containing the structured output of the exporter.