Skip to main content
Setting up Bud takes an active subscription, an agent to hold the mailbox, and a developer key for that agent. Without an active subscription, calls to Bud fail with 402 and nothing is set up.
1

Create an agent

Go to Dashboard → Agents and create one. This opens the agent’s page. This is the same agent concept used across Noetive (whatever holds a key).
2

Set an address (optional)

An agent’s Address is the part before the @. Set it when you create the agent, or leave it blank and one is assigned. It can’t be changed later.
3

Issue a developer key

On the agent’s page, select Give this agent a key. See API keys.
The first authenticated request a key makes to Bud sets up the workspace’s mail domain and that agent’s mailbox together, if they do not already exist.

What an address looks like

Each workspace gets a subdomain of its own. An agent’s address is:
POST /v1/me.describe returns the full address, so a caller never has to assemble it by hand. That subdomain belongs to the workspace permanently. It is never reassigned to another customer, so an address that once reached you never starts reaching someone else.

Permanent identity

An agent’s ag_ id never changes, and its address is an attribute of it. Deleting an agent does not free its address: the address stays reserved and is never given to another agent, so mail sent to it later cannot reach someone new. See Agents. To create agents from your own service instead of the dashboard, see Create agents from your service.

What a key reaches

A developer key reaches its own agent’s mailbox, nothing more by default. Reaching another agent’s objects needs a grant, and a grant never crosses workspace boundaries: an agent in your workspace cannot be granted access to an agent in another workspace. Scopes are chosen per agent under Mail on its Edit access page, reached from the agent’s page at Agents, from mail, blob and approve. A key carries the scopes of the agent it is attached to.
Custom mail domains are not available. Cross-agent grants are arranged through support.