1. Concepts
  2. Stubref

Concepts

Stubref

A globaly unique reference to a stub

Overview

Every stub in Stubber has a unique reference called a stubref. This reference is used to identify a stub in a URL or in a conversation with an AI agent.
Stubrefs are globally unique and can be used to reference stubs across different organizations.

Properties

A stubref has the following properties :

  • date coded to allow easy identification of the stub creation date
  • readable via a human over a telephone
  • has a large enough character set to allow for a large number of stubs to be created
  • is globally unique
  • is case insensitive
  • is URL safe
  • is not easily guessable

Format

A stubref is formatted as follows : YYYY-MM-DD-STUB-[A-Z0-9]{4}

  • YYYY-MM-DD : The date the stub was created
  • STUB : A 4 character reserved string to allow for future expansion, currently 'STUB'
  • [A-Z0-9]{4} : A random 4 character alphanumeric string used to uniquely identify the stub from that date
TIP

If you are chatting to an AI Agent built on the Stubber Platform you can ask "What is the stubref for this conversation?" to get the stubref for the current conversation.

Usage

Stubrefs are also used extensively inside the Stubber platform.
Stubrefa are used to direct actions at certain stubs for processing.
Notification Platforms that use Stubref routing use Stubrefs to route incoming messages that haven't got an active stubsession.

The sendaction task also uses Stubrefs to send an action command to another stub.