Resources »

Guides »

Packages »

Importing packages

What are packages?

Packages are a blueprint for importing a related set of pre-configured records into Cerb. A single package can contain workspaces, dashboards, bots, project boards, custom records, custom fieldsets, tasks, tickets, contacts, etc.

You can build your own packages or import them from our package library.

Importing packages

Packages can be imported from setup, bots, and the API.

Here’s an example package for testing imports:



{
  "package": {
    "name": "Example Package"
  },
  "records": [
    {
      "uid": "task_001",
      "_context": "task",
      "title": "Import your first package",
      "status": "closed"
    }
  ]
}


Setup

Administrators can quickly import packages from their web browser:

  1. Copy a package to your clipboard.

  2. Navigate to Setup » Configure » Import Package.

  3. Paste the package into the text box.

  4. Click the Import button.

Depending on the package, you may be prompted for some configuration options. If so, enter your preferences and click the Import button again.

Once a package has been imported, you’ll see a summary of all the records that have been created.

You can click on the records to open their card popups.

Bots

Bots can import packages using the Package Import action from any behavior. This is currently only available to app-owned bots.

Paste the package into the Package: field.

In Params: you can provide the preferred values for any prompted placeholders required by the package. This is a simple JSON object with keys matching the configure > prompts section of the package.

In the example above, we’re building the JSON object with the dict_set() function, which automatically handles escaping for us.

The action returns a placeholder named _results with details about the created records in the format:



{
  "cerberusweb.contexts.task": {
    "task_001": {
      "id": "258",
      "label": "Import a package from bots"
    }
  }
}


The results object is keyed by record type. Each record type contains an object keyed by uid, with an id and label for each record created.

API

You can use /packages/import.json to import packages using the API.