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
  1. ZBrain Documentation
  2. ZBrain AI agents
  3. Creating custom AI agents
  4. Define Flow
  5. Flow Components

Heartbeat

The Heartbeat component is an all-in-one platform for community businesses that helps monitor and alert.

How to Connect Heartbeat Component to ZBrain Flow?

To integrate Heartbeat with ZBrain Flow, follow these steps to select and utilize the desired capabilities:

  1. Search for the Heartbeat Component: Search the Heartbeat component within the ZBrain interface.

  2. Select the Required Capability: Select the desired capability from these:

  • Create User: Create a new user in a Heartbeat community.

  • Custom API Call: Send a custom API call to a specific endpoint.

Additional Settings for Creating User

Required Fields

  1. API Key* - Select the API connection to authenticate the request.

  2. Name* - Enter the full name of the user.

  3. Email* - Provide a unique email address for the user.

  4. Roles* - Select the role(s) that the user should have.

Optional Fields

  1. Groups - Enter the group IDs the user should belong to.

  2. Profile Picture - Upload an image (JPG, GIF, or PNG format) as a Data URI.

  3. Bio - Provide a brief biography for the user.

  4. Status - Enter the user's status message.

  5. LinkedIn - Add a link to the user's LinkedIn profile.

  6. Twitter - Add a link to the user's Twitter profile.

  7. Instagram - Add a link to the user's Instagram profile.

  8. Create Introduction Thread - If enabled and a bio is provided, an introduction thread will be created for the user.

Additional Settings for Custom API Call

This action allows users to make custom API requests to the Heartbeat platform, enabling advanced interactions beyond predefined actions.

Required Fields

  1. API Key* - Select the API connection to authenticate the request.

  2. Method* - Select the HTTP method for the request (GET, POST, PUT, DELETE).

  3. Headers* - Add authorization and additional headers as key-value pairs.

  4. Query Parameters* - Add query parameters as key-value pairs.

Optional Fields

  1. Body - Enter the request body in JSON format for POST and PUT requests.

  2. Timeout (in seconds) - Set a timeout duration for the request.

Optional Settings

  1. No Error on Failure - Prevents errors from stopping the workflow.

PreviousHacker NewsNextHubSpot

Last updated 1 month ago

URL* - Enter the API endpoint URL (e.g., ).

🤖
https://api.heartbeat.chat/v0