Articles in this section

See more

Add a Guild.ai Agent as an Agent User

Avatar
Support Team
Updated
Follow

Connect a Guild.ai agent to BasicOps so it can work as an Agent User: a dedicated AI team member that can receive BasicOps messages, respond in context, and take action from inside your workspace.

This article will show you how to:

  1. Create an Agent User and API key in BasicOps
  2. Connect BasicOps to Guild.ai
  3. Fork and publish the BasicOps team member agent template
  4. Create and activate the Guild.ai trigger
  5. Register the webhook connection with BasicOps
  6. Use the agent in BasicOps

Before you start

Make sure you have:

Create the Agent User and API key in BasicOps

First, create a dedicated Agent User in BasicOps. This gives the Guild.ai agent its own identity and API key.

  1. In BasicOps, select Settings in the left sidebar.
  2. Select Users.
  3. Open the Agents tab.
  4. Click Add Agent.
  5. Enter the name you want to use for the agent.
  6. Click Add Agent.
  7. When the Add API Key dialog appears, enter a key name, such as the agent name.
  8. Click Add API Key.
  9. Copy the API key shown in the next dialog and store it somewhere safe. You will need it when connecting Guild.ai to BasicOps.

Connect BasicOps in Guild.ai

Next, connect Guild.ai to BasicOps using the agent API key you created.

  1. In Guild.ai, open the BasicOps integration page: https://app.guild.ai/hub/integrations/basicops~basicops.
  2. Click Connect.
  3. Paste the BasicOps agent API key into the API Key field.
  4. Click Connect to save the integration.

Add the BasicOps team member agent template

After the integration is connected, add the BasicOps team member agent template to your Guild.ai workspace.

  1. Open the BasicOps connect to BasicOps as Agent User template in Guild.ai: https://app.guild.ai/hub/agents/basicops~connect-to-basicops-as-agent-user
  2. Click the menu icon next to the agent name.
  3. Select Fork agent.
  4. Click Continue.
  5. Update the Agent Name.
  6. Select a category.
  7. Click Continue.
  8. Click Open Editor.
  9. After the build finishes, click Publish in the top right.
  10. Click Next.
  11. Click Add next to the workspace where you want to add the agent.
  12. Click Next, then click Done.

Create the Guild.ai trigger

Create an event trigger so Guild.ai can send BasicOps events to the agent.

  1. In Guild.ai, open your workspace from the left sidebar.
  2. Select the Triggers tab.
  3. Click Add Trigger.
  4. Choose Event.
  5. For Service, select basicops.
  6. For Event Type, select push.
  7. For Agent, select the BasicOps agent.
  8. Click Create Trigger.

Copy the Guild.ai webhook URL

The webhook URL is the endpoint BasicOps will use to send messages to the Guild.ai agent.

  1. In the same Guild.ai workspace, select the Credentials tab.
  2. Click Manage Credentials in the top right.
  3. In the credentials list, click the settings icon for basicops.
  4. Enable webhooks.
  5. Copy the webhook URL that appears.
  6. Leave the Webhook Secret field empty for now and keep this tab open. Do not save yet.

Generate the webhook secret

Use the BasicOps agent template to register the webhook and generate a signing secret.

  1. Open a second browser tab and return to your Guild.ai workspace.
  2. Select the Agents tab.
  3. Find the BasicOps agent row.
  4. Click the menu icon at the far right.
  5. Select Test agent.
  6. In the chat box, paste the message below. Replace [PASTE YOUR WEBHOOK HERE] with the webhook URL you copied. Leave [signature] and [payload-id] exactly as written.
Call connect_agent with webhook set to [PASTE YOUR WEBHOOK HERE], set kind to guild, set headers to: {"X-Guild-Webhook-Signature":"[signature]","X-Guild-Webhook-ID":"[payload-id]"}, set Signing to "generate", then show the generated secret.
  1. Copy the secret returned by the agent.

Save and activate the trigger

After the webhook secret is generated, save it in Guild.ai and activate the trigger.

  1. Return to the first Guild.ai tab where the webhook credential is open.
  2. Paste the generated secret into the Webhook Secret field.
  3. Click Save.
  4. Return to the Triggers tab.
  5. Find the BasicOps trigger row.
  6. Click the menu icon at the far right.
  7. Select Activate.

Use the agent in BasicOps

Once the trigger is active, the Guild.ai agent can receive BasicOps messages.

  • In BasicOps, @mention the Agent User in any message to ask it to help.
  • To use the agent in a project, first add it to the project team.
  • In a direct chat with the agent, @mentioning is not required.

Troubleshooting

If the agent does not respond in BasicOps, check the following:

  • The BasicOps integration in Guild.ai is connected with the correct Agent User API key.
  • The Guild.ai trigger is active.
  • The webhook URL and webhook secret are saved in Guild.ai.
  • The Agent User has access to the BasicOps channel, task, project, or direct chat where you are messaging it.

Article is closed for comments.