ZBrain Documentation
  • ZBrain Documentation
    • ZBrain XPLR
      • ZBrain XPLR modules
      • Get started with ZBrain XPLR
      • Simulation XPLR
        • AI solutions library
      • Taxonomy XPLR
      • Solution XPLR
      • Portfolio XPLR
      • Functional Design XPLR
    • ZBrain Builder
      • Components of ZBrain Builder
      • 📚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 leverage knowledge base for app creation
          • How to build advanced applications using Flow
        • How to set up and customize your app?
        • How to access the app reporting dashboard?
      • 🤖ZBrain AI agents
        • Get started with agents on ZBrain Builder
        • Deploying pre-built agents
        • Creating custom AI agents
          • Agent setup
          • Define input sources
          • Define Flow
            • Key elements of a Flow
            • Flow Components
              • ActiveCampaign
              • 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
              • Pipedrive
              • 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?
      • 💻Prompts
        • How to create a prompt
        • How to manage and monitor prompts
        • How to manage prompt versions and restore previous versions
        • User management: How to assign prompt permissions?
      • 📺Monitor
      • 🔐Security features
      • Settings
      • 📖API tutorials
        • 📚Knowledge base
          • Automated reasoning
        • 📱APP
        • 🤖Agents
  • ZBrain Release Notes
    • May 2025
      • Version 2.3.1 | May 30, 2025
      • Version 2.3.0 | May 23, 2025
Powered by GitBook
On this page
  1. ZBrain Documentation
  2. ZBrain Builder
  3. ZBrain AI agents
  4. Creating custom AI agents
  5. Define Flow
  6. Flow Components

Pipedrive

The Pipedrive piece in ZBrain Flow provides comprehensive integration with Pipedrive's CRM platform, allowing you to manage sales processes and customer relationships directly from your workflows. This powerful connector enables you to create, update, and query various CRM entities without manual intervention. With Pipedrive integration, you can build automations that maintain sales records, track deals, manage contacts, organize activities, attach documents, and synchronize information across your business systems. This piece is ideal for sales teams looking to streamline their CRM operations, automate repetitive tasks, and ensure consistent data management across their sales pipeline.

How to use Pipedrive in ZBrain Flow

Select Pipedrive as your connection

  • Click on the '+' button in the Flow and search for Pipedrive.

  • Select Pipedrive.

  • Decide on the action you need, then select it. ZBrain Flow provides numerous options across these categories:

    • Deal Management: Create Deal, Update Deal, Find Deal, Add Product to Deal, Find Deals Associated With a Person

    • Contact Management: Create Person, Update Person, Find Person, Add Labels to Person

    • Organization Operations: Create Organization, Update Organization, Find Organization

    • Activity Tracking: Create Activity, Update Activity, Find Activity

    • Product Management: Create Product, Find Product, Retrieve a Product

    • Lead Management: Create Lead, Update Lead

    • Note Operations: Create Note, Retrieve a Note, Find Notes

    • File Management: Attach File

    • User Operations: Find User, Add Follower

    • Custom API Call: Make specialized requests to the Pipedrive API

How to connect to Pipedrive

Before using any Pipedrive action in ZBrain Flow, you must first create a connection with your Pipedrive account.

  • To create the connection, open the 'Connection' dropdown, click on 'Create connection'.

  • A new window will appear where you need to complete the following fields:

    • Enter a name for your connection in the 'Connection Name' field.

    • Click 'Connect' to authenticate and link your Pipedrive account.

    • Click 'Save' to create the connection.

How to assign users to track Pipedrive records

Configuration steps:

  • Once you create a connection, navigate to the 'Follower' dropdown and select the Pipedrive user who should follow the object.

  • From the 'Target Object' dropdown, select the type of record to be followed:

    • Deal

    • Person

    • Organization

    • Product

  • From the 'Target Object ID' dropdown, select the specific record that will be followed. The ID identifies the exact deal, person, organization, or product in your Pipedrive account.

How to retrieve a note

Configuration steps:

  • For connecting to your Pipedrive account, follow the steps in the "How to connect to Pipedrive" section above.

  • In the 'Note ID' field, enter the unique identifier of the note you want to retrieve.

How to create a note in Pipedrive

Configuration steps:

  • For connecting to your Pipedrive account, follow the steps in the "How to connect to Pipedrive" section above.

  • In the 'Content' field, enter the text you want to include in your note.

You can link your note to existing Pipedrive records and pin it for visibility:

  • From the 'Deal' dropdown, optionally select a deal to associate with this note.

    • Toggle 'Pin note to deal?' on to make it prominently visible on the deal.

  • From the 'Person' dropdown, optionally select a contact to associate with this note.

    • Toggle 'Pin note to person?' on to make it prominently visible on the contact record.

  • From the 'Organization' dropdown, optionally select a company to associate with this note.

    • Toggle 'Pin note to organization?' on to make it prominently visible on the company profile.

  • From the 'Lead' dropdown, optionally select a lead to associate with this note.

    • Toggle 'Pin note to lead?' on to make it prominently visible on the lead.

How to add a label to a person

Configuration steps:

  • For connecting to your Pipedrive account, follow the steps in the "How to connect to Pipedrive" section above.

  • From the 'Person' dropdown, select the contact you want to categorize with labels. This displays available contacts from your Pipedrive database.

  • In the 'Label' field, specify the labels you want to associate with this contact. Only existing labels in your Pipedrive account can be used.

How to add a product to a deal

Configuration steps:

  • For connecting to your Pipedrive account, follow the steps in the "How to connect to Pipedrive" section above.

  • From the 'Deal' dropdown, select the sales opportunity to which you want to add a product.

  • From the 'Product' dropdown, choose the specific product you want to associate with this deal.

  • In the 'Price' field, enter the unit price for this product.

  • In the 'Quantity' field, specify how many units of the product are being sold.

  • In the 'Discount' field, optionally enter any discount amount or percentage.

  • From the 'Discount Type' dropdown, select whether the discount is a percentage or an absolute amount.

  • In the 'Comments' field, optionally add any notes specific to this product line item.

  • Toggle 'Enable Product?' on to make the product active in the deal.

  • From the 'Tax Method' dropdown, select how tax should be calculated.

  • In the 'Tax Percentage' field, enter the applicable tax rate if relevant.

How to attach a file to Pipedrive records

Configuration steps:

  • For connecting to your Pipedrive account, follow the steps in the "How to connect to Pipedrive" section above.

  • In the 'File' field, upload or specify the file you want to attach. This can be a document, image, spreadsheet, presentation, or any other supported file type.

  • In the 'File Name' field, enter how you want the file to be named in Pipedrive.

  • You can link your file to one or more existing Pipedrive records:

    • From the 'Deal' dropdown, optionally select a deal to associate this file with.

    • From the 'Person' dropdown, optionally select a contact to attach this file to.

    • From the 'Organization' dropdown, optionally select a company to link this file to.

    • From the 'Product' dropdown, optionally select a product to connect this file with.

    • In the 'Activity ID' field, optionally enter an activity to attach this file to.

How to create an activity

Configuration steps:

  • For connecting to your Pipedrive account, follow the steps in the "How to connect to Pipedrive" section above.

  • In the 'Subject' field, enter a descriptive title for the activity. This should clearly indicate what needs to be done.

  • You can link your activity to existing Pipedrive records:

    • From the 'Organization' dropdown, optionally select a company related to this activity.

    • From the 'Person' dropdown, optionally select a contact involved in this activity.

    • From the 'Deal' dropdown, optionally select a sales opportunity connected to this activity.

    • From the 'Lead' dropdown, optionally select a lead associated with this activity.

  • From the 'Assign To' dropdown, select which user should be responsible for completing this activity.

  • From the 'Activity Type' dropdown, choose the category that best describes this task (call, meeting, email, etc.).

  • In the 'Due Date' field, enter when the activity should be completed (YYYY-MM-DD format).

  • In the 'Due Time' field, optionally specify a due time (HH:MM format).

  • In the 'Duration' field, indicate how long the activity will take (HH:MM format).

  • Toggle 'Mark as Done?' on if the activity is already completed.

  • From the 'Free or Busy' dropdown, select how this should appear on calendars.

  • In the 'Note' field, optionally add private details about the activity.

  • In the 'Public Description' field, optionally add details visible to everyone with access.

How to modify an activity

Configuration steps:

  • For connecting to your Pipedrive account, follow the steps in the "How to connect to Pipedrive" section above.

  • In the 'Activity' field, enter the ID of the activity you want to modify. This identifies the specific task that needs updating.

For the remaining steps, follow the same process outlined in "How to create an activity", updating only the necessary details instead of entering new ones.

How to create a deal in Pipedrive via ZBrain Flow

Configuration steps:

  • For connecting to your Pipedrive account, follow the steps in the "How to connect to Pipedrive" section above.

  • Fill in the required 'Title' field with the name of the deal.

  • Optionally, you can provide 'Creation Time' to specify when the deal was created.

  • Select the 'Status' of the deal if needed—Open, won, lost, and deleted.

  • Choose a 'Stage' if you want to move the deal into a specific stage. If you select a stage here, the 'Pipeline' field will be ignored.

  • If you have not selected a 'Stage,' fill in the 'Pipeline' field.

  • Optionally fill in the pipeline 'Owner' if a specific owner needs to be assigned.

  • You can associate the deal with an 'Organization' or a 'Person' if applicable.

  • Assign a 'Label' if you use labels for deal categorization.

  • Set the 'Probability' field to define the likelihood of closing the deal.

  • Specify an 'Expected Close Date' in the YYYY-MM-DD format.

  • Enter the 'Value' of the deal.

  • Fill in the 'Currency' field using the appropriate currency code.

  • Set the ‘Visible To’ field to either ‘Item Owner’ or ‘All Users’ to control who can view the deal within your organization.

How to configure the update deal action in Pipedrive

Configuration steps:

  • For connecting to your Pipedrive account, follow the steps in the "How to connect to Pipedrive" section above.

  • In the ‘Deal’ field, select the specific deal you want to update.

  • All other fields such as ‘Title’, ‘Creation Time’, ‘Status’, ‘Stage’, ‘Pipeline’, ‘Owner’, ‘Organization’, ‘Person’, ‘Label’, ‘Probability’, ‘Expected Close Date’, ‘Value’, ‘Currency’, and ‘Visible To’ are configured the same way as in the “Create Deal” setup. Please refer to the "How to create a deal in Pipedrive via ZBrain Flow" section for all these common steps. Fill these fields as needed to update the deal details.

How to configure the create lead action in Pipedrive

Before setting up the create lead action, make sure you have connected your Pipedrive account. To do that, follow the connection steps explained in the "How to connect to Pipedrive" section.

Configuration steps:

  • In the ‘Title’ field, enter the title for the lead.

  • From the ‘Owner’ field, assign the lead to a specific user.

  • Enter the organization and person details in the ‘Organization’ and ‘Person’ fields if needed.

  • Use the ‘Label’ field to tag your lead appropriately.

  • If you want to specify when you expect to close the lead, fill the ‘Expected Close Date’ field in YYYY-MM-DD format.

  • Set the visibility of the lead by choosing ‘Item Owner’ or ‘All Users’ in the ‘Visible To’ field.

  • In the ‘Channel’ field, provide the channel through which the lead was sourced.

  • Define the lead’s value in the ‘Lead Value’ field and its corresponding currency code in the ‘Lead Value Currency’ field.

How to configure the update lead action in Pipedrive

Before setting up the update lead action, make sure you have connected your Pipedrive account. To do that, follow the connection steps explained in the "How to connect to Pipedrive" section.

Configuration steps:

  • In the ‘Lead’ field, choose the lead you want to update.

  • After selecting the lead, the remaining steps are the same as those explained in the ‘create lead’ configuration. Please refer to the "How to configure the create lead action in Pipedrive" section for filling fields like ‘Title’, ‘Owner’, ‘Organization’, ‘Person’, ‘Label’, ‘Expected Close Date’, ‘Visible To’, ‘Channel’, ‘Lead Value’, and ‘Lead Value Currency’.

How to configure the create organization action in Pipedrive

Configuration Steps:

  • For connecting to your Pipedrive account, follow the steps in the "How to connect to Pipedrive" section above or select an existing Pipedrive connection to authorize access.

  • Enter the organization’s name in the ‘Name’ field. This is a required input.

  • Choose the organization owner from the ‘Owner’ dropdown, which lists users from your Pipedrive account.

  • Set visibility permissions using the ‘Visible To’ field to control who in your organization can view this record.

  • Select an appropriate category from the ‘Label’ dropdown to tag the organization.

  • Provide the address in the ‘Address’ field, if applicable.

How to configure the update organization action in Pipedrive

Before setting up the update organization action, make sure you have connected your Pipedrive account. To do that, follow the connection steps explained in the "How to connect to Pipedrive" section.

Configuration steps:

  • In the ‘Organization’ field, select the organization you want to update.

  • After selecting the organization, the remaining steps are the same as those explained in the ‘create organization’ configuration. Please refer to the "How to configure the create organization action in Pipedrive" section for filling fields like ‘Name’, ‘Owner’, ‘Visible To’, ‘Label’, and ‘Address’.

How to configure the create person action in Pipedrive

Before setting up the 'Create Person' action, ensure that you have connected your Pipedrive account. To do that, follow the connection steps explained in the "How to connect to Pipedrive" section.

Configuration steps:

  • In the ‘Name’ field, enter the full name of the person you want to add.

  • In the ‘Owner’ field, select the owner from your Pipedrive user list.

  • In the ‘Organization’ field, select the organization to which this person is linked.

  • In the ‘Email’ field, click on ‘Add Item’ and enter the email address of the person. You can add multiple email addresses, if any.

  • In the ‘Phone’ field, click on ‘Add Item’ and enter the phone number of the person. You can add multiple phone numbers, if any.

  • In the ‘Label’ field, choose a label to categorize the person.

  • In the ‘First Name’ field, you can optionally enter the person’s first name.

  • In the ‘Last Name’ field, you can optionally enter the person’s last name.

  • In the ‘Visible To’ field, define who in your Pipedrive account can view this person.

  • In the ‘Marketing Status’ field, select the person’s consent status for marketing communication. The dropdown includes ‘no consent’, ‘unsubscribed’, ‘subscribed’, and ‘archived’.

How to configure the update person action in Pipedrive

Before setting up the update person action, make sure you have connected your Pipedrive account. To do that, follow the connection steps explained in the "How to connect to Pipedrive" section.

Configuration steps:

  • In the ‘Person’ field, choose the person you want to update.

  • After selecting the person, the remaining steps are the same as those explained in the ‘create person’ configuration. Please refer to the "How to configure the create person action in Pipedrive" section for filling fields like ‘Name’, ‘Owner’, ‘Organization’, ‘Email’, ‘Phone’, ‘Label’, ‘First Name’, ‘Last Name’, ‘Visible To’, and ‘Marketing Status’.

How to configure the create product action in Pipedrive

Before setting up the create product action, make sure you have connected your Pipedrive account. To do that, follow the connection steps explained in the "How to connect to Pipedrive" section.

Configuration steps:

  • In the ‘Name’ field, enter the name of the product you want to create.

  • In the ‘Code’ field, enter the internal code or SKU used to identify the product.

  • Use the ‘Description’ field to provide additional details about the product.

  • In the ‘Unit’ field, specify the unit of measurement for the product (e.g., piece, hour, kg).

  • Use the ‘Tax percentage’ field to specify the applicable tax rate for this product.

  • Enable the ‘Is Active?’ checkbox if the product should be marked as active.

  • In the ‘Owner’ field, select a user from your Pipedrive account who will be assigned as the owner of the product.

  • In the ‘Currency’ field, enter the currency code in which the product is priced (e.g., USD, EUR).

  • Use the ‘Price’ field to specify the base selling price of the product.

  • In the ‘Cost’ field, enter the production or purchase cost of the product.

  • In the ‘Overhead Cost’ field, enter any additional indirect costs associated with the product.

  • In the ‘Visible To’ field, define the visibility of the product (item owner and all users).\

How to configure the find deals associated with person action in Pipedrive

Before setting up the find deals associated with person action, make sure you have connected your Pipedrive account. To do that, follow the connection steps explained in the "How to connect to Pipedrive" section.

Configuration steps:

  • In the ‘Person’ field, select the person whose associated deals you want to retrieve from your Pipedrive contact list.

This will retrieve all the deals associated with that specfic person.

How to configure the find product action in Pipedrive

Before setting up the find product action, make sure you have connected your Pipedrive account. To do that, follow the connection steps explained in the "How to connect to Pipedrive" section.

Configuration steps:

  • In the ‘Search Term’ field, enter the keyword or phrase you want to use to find the product in your Pipedrive database. This can be a part of the product name, code, or any identifying term.

How to configure the find products action in Pipedrive

Before setting up the find products action, make sure you have connected your Pipedrive account. To do that, follow the connection steps explained in the "How to connect to Pipedrive" section.

Configuration steps:

  • From ‘Field to search by’ dropdown, select whether you want to search using the product ‘Name’ or ‘Product Code’.

  • In the ‘Field Value’ field, enter the specific name or product code you want to use for the search.

How to configure the find notes action in Pipedrive

Before setting up the find notes action, make sure you have connected your Pipedrive account. To do that, follow the connection steps explained in the "How to connect to Pipedrive" section.

Configuration steps:

  • In the ‘Search By’ field, select the type of record you want to find notes for. You can choose from ‘Deal’, ‘Lead’, ‘Person’, or ‘Organization’.

  • In the ‘ID’ field, enter the ID of the selected record type for which you want to retrieve notes.

How to configure the retrieve a product action in Pipedrive

Before setting up the retrieve a product action, make sure you have connected your Pipedrive account. To do that, follow the connection steps explained in the "How to connect to Pipedrive" section.

Configuration steps:

  • In the ‘Product ID’ field, enter the ID of the product you want to retrieve details for.

How to configure the find organization action in Pipedrive

Before setting up the find organization action, make sure you have connected your Pipedrive account. To do that, follow the connection steps explained in the "How to connect to Pipedrive" section.

Configuration steps:

  • In the ‘Field to search by’ field, specify the organization field you want to search with. This could be the organization name, ID, or any other supported search field.

How to configure the find person action in Pipedrive

The configuration steps for this action are the same as those explained in the "How to configure the find organization action in Pipedrive" section. Follow the same approach to create a connection and fill the ‘Field to search by’ to retrieve person records.

How to configure the find deal action in Pipedrive

The configuration steps for this action are the same as those explained in the "How to configure the find organization action in Pipedrive" section. Follow the same approach to create a connection and fill the ‘Field to search by’ to retrieve a deal’s records.

How to configure the find activity action in Pipedrive

Before setting up the find activity action, make sure you have connected your Pipedrive account. To do that, follow the connection steps explained in the “How to connect to Pipedrive” section.

Configuration steps:

  • In the ‘Subject’ field, enter the title or subject of the activity you want to search for.

  • Enable the ‘Exact Match’ option if you want to search only for activities that exactly match the subject text.

  • In the ‘Assign To’ field, select the user the activity is assigned to.

  • In the ‘Activity Type’ field, choose the type of activity you are looking for, such as a call, meeting, or task.

  • In the ‘Filter’ field, apply any existing filters from your Pipedrive account to narrow down the results.

  • In the ‘Status’ field, select whether to retrieve activities marked as ‘Done’ or ‘Not done’.

How to configure the find user action in Pipedrive

Before setting up the find user action, make sure you have connected your Pipedrive account. To do that, follow the connection steps explained in the “How to connect to Pipedrive” section.

Configuration steps:

  • From the ‘Field to search by’ dropdown, choose the user attribute you want to search by. This could be a field like name or email.

  • In the ‘Field Value’ field, enter the value corresponding to the selected search field to locate the user.

How to configure the custom API call action in Pipedrive

Before setting up the custom API call action, make sure you have connected your Pipedrive account. To do that, follow the connection steps explained in the “How to connect to Pipedrive” section.

Configuration steps:

  • In the ‘URL’ field, enter the full API endpoint or the relative path. For example, https://api.pipedrive.com/v1/deals or /deals.

  • In the ‘Method’ field, choose the HTTP method to be used for the API call (e.g., GET, POST, PUT, PATCH, DELETE, HEAD).

  • In the ‘Headers’ section, click ‘Add Item’ to add any custom headers needed for the request. Authorization headers will be added automatically from your Pipedrive connection.

  • In the ‘Query Parameters’ section, click ‘Add Item’ to specify any query parameters to be passed along with the request.

  • In the ‘Body’ section, enter the request payload if the method requires it (e.g., POST or PUT).

  • Optionally, you can togggle ‘No Error on Failure’ if you don’t want the flow to fail when the API call fails.

  • In the ‘Timeout (in seconds)’ field, set a timeout duration for the request. If left blank, the default system timeout will be used.

This setup allows you to make custom API requests to Pipedrive’s endpoints beyond the predefined actions, enabling more control and flexibility.

PreviousPDFNextPostgres

Last updated 1 day ago

🤖