Skip to content

Rewrite: SignalWire Resources doc #412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Manny-r31 wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Rewrite: SignalWire Resources doc #412

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
bb8f63c
Rewrote Resources page to more accurately describe the resource ecosy…
Manny-r31 Jun 15, 2026
9e8ecbc
Small formatting update
Manny-r31 Jun 15, 2026
e126937
Merge branch 'main' into Manny/resources-page-rewrite
hey-august Jun 22, 2026
fbb8f61
Merge branch 'main' into Manny/resources-page-rewrite
hey-august Jun 23, 2026
765b019
Merge branch 'main' into Manny/resources-page-rewrite
Manny-r31 Jun 24, 2026
928dbea
Merge branch 'main' into Manny/resources-page-rewrite
Manny-r31 Jun 25, 2026
9f6ecf9
Merge branch 'main' into Manny/resources-page-rewrite
Manny-r31 Jun 25, 2026
7185fa0
Merge branch 'main' into Manny/resources-page-rewrite
hey-august Jun 26, 2026
beae7f5
Merge branch 'main' into Manny/resources-page-rewrite
hey-august Jun 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
107 changes: 73 additions & 34 deletions fern/products/platform/pages/platform/call-fabric/resources.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,32 +11,67 @@ x-custom:
---


Resources are the primary entities for communication within the Call Fabric ecosystem.
They are the building blocks of the system, representing the various communication elements
that can be used to interact with
[subscribers](/docs/platform/subscribers).
Resources are the core building blocks of the SignalWire ecosystem.
They are container objects that represent your choice of communication entity.
This can be anything from a SignalWire AI Agent or a SWML script, to a Subscriber that can be created, addressed and called within your SignalWire Space.

Every Resource has a **Type** and one or more **Addresses** that make it reachable, and all Resources share the same addressing and management model.
No matter what Resource you need you can create, configure, and call them all in the same consistent way.

## Resource types

Call Fabric supports several Resource types. Some of the most common are:

<CardGroup cols={3}>
<Card title="Subscribers" href="/docs/platform/subscribers">
Users in your communication system, with built-in authentication and communication endpoints.
</Card>
<Card title="AI Agents" href="/docs/platform/ai">
Conversational AI agents that can answer and place calls.
</Card>
<Card title="SWML Scripts" href="/docs/swml">
Programmable call logic written in SWML (JSON or YAML).
</Card>
<Card title="cXML Scripts" href="/docs/compatibility-api/cxml">
Twilio-compatible call logic for migrating existing applications.
</Card>
<Card title="SIP Endpoints" href="/docs/platform/voice/sip">
Register SIP devices and softphones to your Space.
</Card>
<Card title="Video Rooms" href="/docs/platform/video">
Programmable video conference rooms.
</Card>
</CardGroup>

Each of these Resource types use the same addressing and management patterns described below.

## Resource addresses

Every Resource is uniquely identified by one or more **Addresses** in the form `/context/name`.
For example, an AI Agent named `Sigmond` in the public context is reachable at `/public/Sigmond`.
The context is either `public` or `private`, and the name defaults to the Resource's name. Addresses are mutable, and a single Resource can have multiple addresses, including phone numbers and SIP URIs.

@hey-august hey-august Jun 22, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should get clarity from Product on this before publishing, and also update the Resource Addresses snippet that populates the Addresses doc.

I have heard of 3 different reserved contexts: public, private, and external. We need to nail down exactly what each of these does.


Learn more in the [Resource Addresses](/docs/platform/addresses) guide, including contexts, naming conventions, and routing options.

## Manage Resources

### With the REST API

Use the Resources endpoints to manage your Resources programmatically.
Use the Resources endpoints to work with any Resource programmatically, regardless of type.
The generic Resources endpoint lets you [list](/docs/apis/rest/resources/list-resources) all Resources,
[retrieve](/docs/apis/rest/resources/get-resource) or [delete](/docs/apis/rest/resources/delete-resource) a Resource by
ID, and [list a Resource's addresses](/docs/apis/rest/addresses/list-resource-addresses-client).

<Card title="Resources endpoints" href="/docs/apis/rest/resources/list-resources">
Control Resources using the SignalWire REST API.
</Card>
To **create** or **update** a Resource, use the endpoint for its specific type.
For example, if you wanted to create a new SWML Script you would utilize the [Create SWML Script](/docs/apis/rest/swml-scripts/create-swml-script) endpoint.

### In the Dashboard

The Dashboard is your unified command center for your SignalWire Space. Access it at `{your-space-name}.signalwire.com`.
The [SignalWire Dashboard](https://my.signalwire.com/resources) can also be used as your unified command center for your SignalWire Resources.
You can create, manage, edit, delete, and test your Space's Resources all from your web browser.

#### Create

<Info title="No Resources tab?">
If you don't see the **My Resources** tab, your SignalWire Space is on the **Legacy Dashboard**.
Refer to the [Legacy](#in-the-legacy-dashboard) section of this guide for instructions for your Dashboard and information about the migration.
</Info>

<Steps>
<Step title="Navigate to Resources">
To create a Resource in your SignalWire Space, click on the **My Resources** tab in the left-hand navigation menu.
Expand All @@ -48,15 +83,8 @@ Refer to the [Legacy](#in-the-legacy-dashboard) section of this guide for instru
</Step>
</Steps>




<Frame

caption="Create a new Resource from the Dashboard">

<Frame caption="Create a new Resource from the Dashboard">
![Create a new Resource from the Dashboard.](/assets/images/dashboard/home/home-resources-marked.webp)

</Frame>

Click the **Add** button to select from the grid of available Resource types.
Expand All @@ -67,9 +95,13 @@ Click the **Add** button to select from the grid of available Resource types.

Alternatively, you can create new Resources from their subpages in the sidebar menu, or using the shortcuts on the Dashboard homepage.

After selecting a Resource,
enter the details for the Resource on a new page,
and select <kbd>Create</kbd> to confirm.
After selecting a Resource, enter the details for the Resource on a new page, and select <kbd>Create</kbd> to confirm.

<Info title="No Resources tab?">
If you don't see the **My Resources** tab, your SignalWire Space is on the **Legacy Dashboard**,
which does not support the Resources experience. [Contact Support](https://support.signalwire.com/)
to upgrade your Space to the new UI.
</Info>

#### Modify or delete

Expand All @@ -80,12 +112,19 @@ Here, by selecting the `Edit` button, you can alter the specifics of the Resourc
![The list of Resources in a SignalWire Space.](/assets/images/dashboard/resources/resource-list.webp)
</Frame>

---

## In the Legacy Dashboard

The **Resources experience** is not available in the Legacy Dashboard.

To upgrade your Space to the New UI, [contact Support](https://support.signalwire.com/).

<Markdown src="/snippets/common/dashboard/_ui-accordion.mdx" />
## Next steps

<CardGroup cols={2}>
<Card title="Subscribers" href="/docs/platform/subscribers">
Manage the users in your communication system via subscribers.
</Card>
<Card title="Resource Addresses" href="/docs/platform/addresses">
Understand contexts, naming, and how Resources are identified and called.
</Card>
<Card title="Resources REST API" href="/docs/apis/rest/resources/list-resources">
List, retrieve, and delete Resources programmatically.
</Card>
<Card title="AI Agents" href="/docs/platform/ai">
Build conversational AI agents as Resources.
</Card>
</CardGroup>
Loading