ZBrain Documentation
  • ZBrain Documentation
    • Components of ZBrain
    • Getting started with ZBrain
    • πŸ“šKnowledge base
      • How to create a knowledge base?
      • Knowledge source
      • Information schema
      • File summary
      • Automated reasoning
      • Retrieval testing
      • Knowledge base settings
    • πŸ“±APP
      • How to create a new app?
      • How to set up and customize your app?
      • How to access the app reporting dashboard?
    • πŸ€–ZBrain AI agents
      • Get started with agents on ZBrain
      • Deploying pre-built agents
      • Creating custom AI agents
        • Agent setup
        • Define input sources
        • Define Flow
          • Key elements of a Flow
          • Flow Components
            • Activepieces Platform
            • AITable
            • Airtable
            • Amazon S3
            • Amazon SNS
            • Amazon SQS
            • Amazon Textract
            • Apify
            • Apollo
            • Approval
            • Asana
            • Azure Communication Services
            • Azure Cosmos DB
            • Azure Document Intelligence
            • Azure OpenAI
            • Azure Translation
            • Bannerbear
            • Baserow
            • Beamer
            • Bedrock Claude
            • Bettermode
            • Binance
            • Bing Search
            • Blackbaud
            • Bonjoro
            • Box
            • Brevo
            • Brilliant Directories
            • Bubble
            • CSV
            • Calendly
            • Certopus
            • Clearout
            • Clockodo
            • Code
            • Confluence
            • Connections
            • Constant Contact
            • Contiguity
            • Contentful
            • Customer.io
            • Crypto
            • Databricks
            • Data Mapper
            • Date Helper
            • DeepL
            • Delay
            • Discord
            • Discourse
            • Drip
            • Dropbox
            • Dust
            • Facebook Pages
            • Figma
            • Files Helper
            • Flowise
            • Flowlu
            • Formbricks
            • Frame
            • Freshdesk
            • Freshsales
            • GCloud Pub/Sub
            • GenerateBanners
            • GhostCMS
            • GitHub
            • GitLab
            • Gmail
            • Google Calendar
            • Google Contacts
            • Google Docs
            • Google Drive
            • Google Forms
            • Google Gemini
            • Google My Business
            • Google Search
            • Google Search Console
            • Google Sheets
            • Google Tasks
            • Groq
            • Hacker News
            • Heartbeat
            • HubSpot
            • HTTP
            • Image Helper
            • Inputs
            • Instagram for Business
            • Intercom
            • Invoice Ninja
            • Jira Cloud
            • Jotform
            • Kimai
            • Kizeo Forms
            • LeadConnector
            • Line Bot
            • Linear
            • LinkedIn
            • LinkedIn Actions
            • LLMRails
            • Lusha
            • MailerLite
            • Mailchimp
            • Mautic
            • Microsoft Dynamics 365 Business Central
            • Microsoft Dynamics CRM
            • Microsoft Excel 365
            • Microsoft OneDrive
            • Microsoft Outlook Calendar
            • Microsoft Teams
            • Mixpanel
            • MongoDB
            • Notion
            • Odoo
            • OpenAI
            • OpenRouter
            • Pastebin
            • PDF
            • Postgres
            • PostHog
            • Pushover
            • Qdrant
            • Queue
            • Razorpay
            • Router
            • Salesforce
            • SendGrid
            • ServiceNow
            • SFTP
            • SharePoint
            • Slack
            • SMTP
            • Snowflake
            • SOAP
            • Spotify
            • Stability AI
            • Stable Diffusion Web UI
            • Storage
            • Stripe
            • SurrealDB
            • SurveyMonkey
            • Taskade
            • Telegram Bot
            • Text Helper
            • Trello
            • Twilio
            • Twitter
            • Utilities
            • WhatsApp Business
            • WordPress
            • XML
            • YouTube
            • ZBrain
            • Zendesk
            • ZeroBounce
            • Zoho Books
            • Zoho CRM
            • Zoho Invoice
            • Zoom
          • How to Define a Flow?
          • How to Test Each Step in the Flow?
        • Configure Additional Settings
        • Test and Deploy Agents
        • How to access, monitor, and manage agent performance and tasks?
    • Settings
    • πŸ“–API Tutorials
      • πŸ“šKnowledge base
        • Automated Reasoning
      • πŸ“±APP
      • πŸ€–Agents
Powered by GitBook
On this page
  • How to Integrate Freshdesk with ZBrain Flow
  • How to Create a Connection Between Freshdesk and ZBrain Flow
  • How to Retrieve Base URL and API Token from Freshdesk
  • Available Actions in ZBrain Flow
  • Where to Find Contact ID in Freshdesk?
  • Where to Find Ticket ID in Freshdesk?
  • Configuration Steps
  1. ZBrain Documentation
  2. ZBrain AI agents
  3. Creating custom AI agents
  4. Define Flow
  5. Flow Components

Freshdesk

Freshdesk is a cloud-based customer support platform that helps businesses manage customer interactions through ticketing, automation, and multi-channel support. It enables teams to efficiently handle customer queries via email, chat, phone, social media, and self-service portals. Freshdesk also offers AI-powered automation, analytics, and integrations to improve response times and enhance customer satisfaction.

How to Integrate Freshdesk with ZBrain Flow

To integrate Freshdesk with ZBrain Flow:

  1. Click the β€˜+’ button in ZBrain Flow.

  2. In the search bar, type "Freshdesk" and select it from the available options.

  3. Choose an available action to start the setup process.

How to Create a Connection Between Freshdesk and ZBrain Flow

To establish a connection between Freshdesk and ZBrain Flow:

  1. Enter a Connection Name – Provide a name for easy identification.

  2. Enter the Base URL and API Token – These credentials are required for authentication.

  3. Click β€˜Save’ – This completes the connection setup.

How to Retrieve Base URL and API Token from Freshdesk

Base URL:

  • Log in to your Freshdesk account.

  • The base URL follows this format:

https://yourdomain.freshdesk.com

Replace yourdomain with your actual Freshdesk subdomain.

API Token:

  • Click on your profile picture in the top-right corner.

  • Select "Profile Settings".

  • In the right panel, locate and click β€˜View API Key.’

  • Complete the captcha verification to reveal and copy your API key.

  • Use this API key for authentication in ZBrain Flow.

Available Actions in ZBrain Flow

1. Get Tickets

Retrieves a list of support tickets from Freshdesk, allowing for automated tracking and reporting.

Configuration Steps

  • Select an existing connection or create a new one.

2. Get Contact from ID

Fetches detailed information about a specific contact in Freshdesk using a Contact ID.

Configuration Steps

  • Select an existing connection or create a new one.

  • Enter the Contact ID.

Where to Find Contact ID in Freshdesk?

  • Log in to Freshdesk.

  • Navigate to Contacts from the dashboard.

  • Click on a contact to open their details.

  • The Contact ID is visible in the URL.

Example:

https://yourdomain.freshdesk.com/a/contacts/56789

Here, 56789 is the Contact ID.

3. Get Ticket Status

Retrieves the current status (e.g., Open, Pending, Resolved, or Closed) of a specific support ticket.

Configuration Steps

  • Select an existing connection or create a new one.

  • Enter the Ticket ID to fetch its status.

Where to Find Ticket ID in Freshdesk?

  • Log in to Freshdesk.

  • Go to the Tickets section from the dashboard.

  • Each ticket has a unique Ticket ID displayed next to its title or in the ticket URL.

Example:

https://yourdomain.freshdesk.com/a/tickets/12345

Here, 12345 is the Ticket ID.

4. Get Freshdesk Contacts

Retrieves a list of contacts from Freshdesk, with optional filtering to refine results.

Configuration Steps

  • Select an existing connection or create a new one.

  • Choose an optional filter:

    • Email

    • Mobile

    • Phone

    • Company ID

    • Updated Since

  • Enter the filter value (if an optional filter is selected).

  • Select an optional status filter (Blocked, Deleted, Unverified, or Verified).

  • Enter the number of results to return (set to 0 for all results; max is 100).

5. Get All Tickets by Status

Fetches support tickets filtered by their status.

Configuration Steps

  • Select an existing connection or create a new one.

  • Choose one or more ticket statuses:

    • Open

    • Pending

    • Resolved

    • Closed

6. Custom API Call

Allows users to execute API requests to Freshdesk for advanced operations.

Configuration Steps

  • Select an existing connection or create a new one.

  • Choose the HTTP Method:

    • GET – Retrieve tickets, contacts, or other data.

    • POST – Create new contacts or tickets.

    • PATCH – Update existing records.

    • PUT – Replace complete records.

    • DELETE – Permanently remove data.

    • HEAD – Fetch response headers without retrieving content.

  • Add Headers – Define any additional headers required for the API request. Authorization headers are automatically injected. Click β€˜+ Add Item’ to include more headers.

  • Add Query Parameters – Customize API requests with query parameters to filter results or specify additional options. Click β€˜+ Add Item’ to add more parameters.

  • Enter JSON Body – Provide structured request data in JSON format.

  • Set Timeout (in Seconds) – Define a timeout duration to prevent delays in processing.

Note: Click β€˜f’ to insert dynamic values for flexible configurations.

PreviousFrameNextFreshsales

Last updated 1 month ago

πŸ€–