Back to Novu

Create an agent

docs/agents/custom-code-agent/setup-your-agent/create-an-agent.mdx

3.18.02.3 KB
Original Source

Create an agent in the Novu dashboard before you scaffold a bridge app or write handler code. This page walks through creating the agent record and connecting your first provider.

Create an agent in the dashboard

In the Novu dashboard, create a new agent and enter its basic details.

<Steps> <Step title="Go to the Agents page"> In the Novu dashboard, open the [Agents page](https://dashboard.novu.co/agents). </Step> <Step title="Open Agents"> In the sidebar, click **Agents**. </Step> <Step title="Create agent"> Enter a name and description, then click **Create agent**. </Step> <Step title="Enter agent details"> Enter the following information: - **Agent name**: Display name for your agent. Slack and Microsoft Teams show this name when users mention the agent. - **Identifier**: Unique slug used in code. Auto-generated from the name; cannot be changed after creation. - **Description**: Summary of the agent's purpose. </Step> <Step title="Set up agent"> Click **Set up agent**. Novu opens the guided setup page, where you connect providers and copy the scaffold command for your bridge app. </Step> </Steps> <video autoPlay loop muted playsInline src="/images/agents/custom-code-agent/setup-your-agent/create-a-new-agent.mp4" />

Connect a provider

On the guided setup page in the Novu dashboard, link your agent to a messaging provider.

<Steps> <Step title="Select a provider"> In the **Select provider** list, choose a provider (for example, **Slack**). </Step> <Step title="Follow provider-specific steps"> </Step> </Steps>

For a full Slack walkthrough including app creation and install, see Quickstart.

<Columns cols={2}> <Card icon="terminal" href="/agents/custom-code-agent/setup-your-agent/scaffold-your-project" title="Scaffold your project"> Generate a bridge application with the Novu CLI. </Card> <Card icon="layout-dashboard" href="/agents/custom-code-agent/setup-your-agent/overview" title="Set up overview"> View dashboard settings, bridge URL, providers, and handler code. </Card> <Card icon="zap" href="/agents/custom-code-agent/quickstart" title="Quickstart"> Create an agent, connect Slack, and get a reply in-thread. </Card> </Columns>