Slug rules and reserved names

On this page

The rules
Uniqueness
Reserved names
Changing a slug

Slugs are the URL-safe names for your organisation and your entities. They appear in every in-product URL, so they are worth choosing deliberately.

The rules#

Slug rules
Rule	Detail
Characters	Lowercase letters, digits and hyphens only
Length	3 to 30 characters
First and last character	Must be a letter or digit, never a hyphen
Case	Lowercase only. An uppercase character is rejected, not silently converted
Reserved names	Rejected, see the list below

acme-group        valid
berlin-gmbh       valid
unit-7            valid

Acme-Group        rejected, uppercase
-acme             rejected, leading hyphen
ac                rejected, shorter than 3 characters
docs              rejected, reserved

The setup wizard derives a slug from the name you type, lowercasing it and collapsing anything that is not a letter or digit into single hyphens. Once you edit the slug field yourself it stops following the name.

Uniqueness#

Where a slug must be unique
Slug	Must be unique across
Organisation slug	All of Governax. Another customer may already hold the one you want.
Entity slug	Only its own organisation. Two organisations may both have head-office.

An entity slug collision inside one organisation returns ENTITY_SLUG_TAKEN with HTTP 409.

Reserved names#

Some names are refused because they would collide with an application route, and others because they could be used to impersonate Governax itself. The current list:

accept-invite   account         admin           api
app             assets          acme            auth
billing         blog            clouvylabs      console
dashboard       decisions       docs            entities
entity          false           forgot-password governax
help            invite          login           logout
mail            me              members         null
oauth-test      onboarding      org             organization
organizations   orgs            register        reset-password
settings        signin          signup          static
status          support         team            teams
true            undefined       user            users
verify-email    www             you             _next

Changing a slug#

There is no interface for renaming an organisation or entity slug. Every in-product URL is built from the slug, and existing links, bookmarks and saved queries would break. If you need a change, contact support.

Slugs are cosmetic in one important respect: nothing in the ledger references them. Governance events are keyed to internal identifiers, so a slug change would not disturb any recorded history. See Anatomy of a governance event.