Skip to main content

Tutorial: Zendesk Leads Manager Agent

This Agent is capable of managing your leads on Zendesk. It can retrieve all of your leads or just a single one, depending upon your needs. It can also create new leads, update existing leads, or delete them if needed.

Personal API Token

  1. Go to https://www.zendesk.com/ and register if you don’t have an account yet. (You can skip this process if you already have one).
  2. In your Zendesk dashboard, click on the Bento icon located in the upper right corner of the page.
alt text
  1. Click Sell from the drop-down menu.
alt text
  1. On the left sidebar, click the gear icon to access the settings.
alt text
  1. Scroll down to the Integrations section, then click on OAuth.
alt text
  1. Click the Add Access Token button to generate your personal access token.
alt text
  1. For easy identification, add a description to your API Token, then save.
alt text
  1. Remember to copy and securely store your generated token as it will not be displayed again after clicking the Save button.
alt text

Agent Setup

  1. In SmythOS, navigate to the templates tab.
alt text
  1. You can scroll down to find the Zendesk Leads Manager Agent or simply search for it in the Search tab, then click the Remix button.
alt text
  1. Allow the template to initialize and configure.

LLM Prompt Component Setup

  1. Look for the Zendesk Personal Token component.
alt text
  1. Click on the gear icon to open the settings, then input your Zendesk Token in the Prompt. Remember to click the check mark to save your configuration.
alt text
  1. You’re all set!

Test the Agent

  1. Open the ChatBot embodiment and click on the chat icon.
alt text

Create a Lead

  1. Ask the agent to create a lead.
alt text
  1. The agent will then ask for the following information.
alt text
  1. Sample lead

    1. Smith
    2. Evergreen Solutions Inc.
    3. evergreen.com
    4. jsmith@gmail.com
    5. (555) 123-4567
  2. The agent has successfully created the lead.

alt text
  1. Now, let's verify your Zendesk dashboard to confirm the creation of the new lead.
alt text

Retrieve a Single Lead

  1. Ask the agent to retrieve a single lead.
alt text
  1. Provide the Lead ID that you want to retrieve.

    1. Sample
      1. 2190326053 (This is the lead ID for Smith - Evergreen Solutions)
  2. Here’s the result!

alt text

Retrieve all Leads

  1. Ask the agent to retrieve all leads. Currently, we have 4 leads in our sample account.
alt text
  1. Here’s the result!
alt text
alt text
alt text
alt text

Update a Lead

  1. Ask the agent to update a lead.
alt text
  1. Let’s update Johnson’s information.

    1. Johnson’s old information.
      1. 2190325344
      2. Johnson
      3. FreshStart Services
      4. freshstartsvc.com
      5. johnson@freshstart.com
      6. (555) 555-7834
    2. Let’s update with the following new information.
      1. 2190325344
      2. Johnson
      3. Fresh Services
      4. fresh.com
      5. johnson@fresh.com
      6. (555) 555-7835
  2. Here’s the result!

alt text
  1. Now, let's check your Zendesk dashboard to confirm the update of Johnson's account.
alt text

Delete a Lead

  1. Ask the agent to delete a lead.
alt text
  1. For instance, let’s delete Smith - Evergreen Solutions - ID: 2190326053
alt text
  1. Here’s the result!
alt text