Skip to main content

Register as a developer

Anyone who meets the eligibility rules below can build apps, integration connectors and workflow nodes for Workspaces. You do not need to be a paying Workspaces customer: registering is free and works on any plan, including Free.

The public entry point is Build on Workspaces. This page describes the same journey in detail.

Who can register​

  • You have a Burdenoff account with a verified email address. Any plan works, including Free.
  • You have reached the age of majority where you live, or you register on behalf of a company and have the authority to bind it.
  • You accept the Marketplace & Developer Agreement and the Acceptable Use Policy for everything you build and submit.
  • You are not barred from receiving software or services under applicable export-control or sanctions laws.
  • Every submission is reviewed before it is listed. Free and private apps need nothing more. Paid listings also need publisher verification (legal details, tax and payouts) before they go live.

Step 1: create an account​

  1. Open Build on Workspaces and choose Create a developer account. This opens the sign-up form at app.burdenoff.com with the developer portal set as your destination.
  2. Fill in your name, username, email and password and submit the form.
  3. Open the confirmation email and follow the link. After the email is confirmed you are taken to sign in; signing in takes you straight to the developer portal setup.

If you already have an account, choose I already have an account instead. You can also open the developer portal at any time from Developer Portal in the Workspaces navigation, or directly at https://app.burdenoff.com/devportal.

Step 2: create your developer organization​

The setup wizard opens the first time you visit the developer portal without an organization.

  1. Enter the organization name. The URL slug is filled in from the name; change it if you like (lowercase letters, numbers and hyphens).
  2. Read the Who can register rules, then tick the box to accept the Marketplace & Developer Agreement and the Acceptable Use Policy. The wizard records which version of the agreement you accepted, and when, on the organization.
  3. Choose Create & Continue.

This one step creates both halves of your developer identity:

  • your developer profile, the personal record behind everything you publish (you can add a website, bio and social links later under Developer Portal > Profile), and
  • your developer organization, the publisher identity that owns your apps and that you can invite teammates to.

Step 3: register your first app​

Pick what you are building:

TypeWhat it isCan be submitted right away
AppAn API integration with OAuth clients, API keys and webhooksYes
NodeA custom workflow node, reviewed from an uploaded packageAfter the first package version is uploaded
WorkflowA reusable automation template, reviewed from an uploaded packageAfter the first package version is uploaded

Give the app a name, a category and a short description, then choose Create App. New apps are private.

Step 4: submit it for review​

For an API integration, the wizard's next step is Submit for review. Add optional notes for the reviewer (what the app does and how to try it) and submit. The app's status changes to Submitted and it enters the review queue. It stays private until a reviewer approves it and you publish it.

For a node or workflow template, upload the first package version from the app's Versions tab, then submit the app from its page.

You can also choose Submit later and submit from the app's page at any time.

The onboarding checklist​

Until you have submitted your first app, the developer portal dashboard shows a Get started as a developer checklist with four steps: developer profile, developer organization, first app and submission. Each open step links to the page that completes it, and the checklist disappears once all four are done.

Doing the same through the API​

Every step is an ordinary GraphQL mutation on the global gateway, available to any signed-in user:

StepMutation
Developer profilecreateDeveloperProfile(input: CreateDeveloperProfileInput!) (returns your existing profile if you already have one)
Developer organizationcreateDeveloperOrganization(input: CreateDeveloperOrganizationInput!)
First appcreateApplication(input: CreateApplicationInput!) with developerOrganizationId
Submit for reviewsubmitApplication(id: ID!, notes: String)

See the GraphQL API guide for authentication and endpoints, and the Node.js SDK and CLI reference for the devportal module and command group.

Next steps​

  • Publish a connector to list an API-key integration in the Workspaces integrations catalog.
  • Webhooks to receive signed events for your app.
  • Quick start to make your first authenticated API call.