{"id":21017632,"url":"https://github.com/orbit-love/community-ruby-pipedrive-orbit","last_synced_at":"2025-05-15T05:33:51.054Z","repository":{"id":50998081,"uuid":"367065953","full_name":"orbit-love/community-ruby-pipedrive-orbit","owner":"orbit-love","description":"Integrate Pipedrive activities into your Orbit workspace","archived":false,"fork":false,"pushed_at":"2023-08-24T01:37:47.000Z","size":168,"stargazers_count":6,"open_issues_count":2,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-19T05:16:45.036Z","etag":null,"topics":["api","community","crm","orbit","pipedrive","pipedrive-api","ruby","rubygem"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/orbit-love.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-05-13T13:59:05.000Z","updated_at":"2023-07-25T14:46:04.000Z","dependencies_parsed_at":"2023-12-01T06:43:57.423Z","dependency_job_id":null,"html_url":"https://github.com/orbit-love/community-ruby-pipedrive-orbit","commit_stats":{"total_commits":14,"total_committers":2,"mean_commits":7.0,"dds":0.0714285714285714,"last_synced_commit":"222711e90cb564fca5fa71afaa0e8740f1b63ff4"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orbit-love%2Fcommunity-ruby-pipedrive-orbit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orbit-love%2Fcommunity-ruby-pipedrive-orbit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orbit-love%2Fcommunity-ruby-pipedrive-orbit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orbit-love%2Fcommunity-ruby-pipedrive-orbit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/orbit-love","download_url":"https://codeload.github.com/orbit-love/community-ruby-pipedrive-orbit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254282994,"owners_count":22045131,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","community","crm","orbit","pipedrive","pipedrive-api","ruby","rubygem"],"created_at":"2024-11-19T10:20:20.999Z","updated_at":"2025-05-15T05:33:50.670Z","avatar_url":"https://github.com/orbit-love.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"# Pipedrive Interactions to Orbit Workspace\n\n![Build Status](https://github.com/orbit-love/community-ruby-pipedrive-orbit/workflows/CI/badge.svg)\n[![Gem Version](https://badge.fury.io/rb/pipedrive_orbit.svg)](https://badge.fury.io/rb/pipedrive_orbit)\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](.github/CODE_OF_CONDUCT.md)\n\nAdd your Pipedrive CRM interactions into your Orbit workspace with this community-built integration.\n\n![Example screenshot of a new Pipedrive activity in Orbit](readme-images/new-activity-screenshot.png)\n![Example screenshot of a new Pipedrive note in Orbit](readme-images/new-note-screenshot.png)\n\n|\u003cp align=\"left\"\u003e:sparkles:\u003c/p\u003e This is a *community project*. The Orbit team does its best to maintain it and keep it up to date with any recent API changes.\u003cbr/\u003e\u003cbr/\u003eWe welcome community contributions to make sure that it stays current. \u003cp align=\"right\"\u003e:sparkles:\u003c/p\u003e|\n|-----------------------------------------|\n\n![There are three ways to use this integration. Install package - build and run your own applications. Run the CLI - run on-demand directly from your terminal. Schedule an automation with GitHub - get started in minutes - no coding required](readme-images/ways-to-use.png)\n\n## First Time Setup\n\nTo set up this integration you will need your Pipedrive API key and Pipedrive organization URL. See the below table for instructions on where to find those details.\n## Application Credentials\n\nThe application requires the following environment variables:\n\n| Variable | Description | More Info\n|---|---|--|\n| `PIPEDRIVE_API_KEY` | API key for Pipedrive | Found in `Personal Preferences -\u003e API` in your Pipedrive user settings\n| `PIPEDRIVE_URL` | Organizational Pipedrive URL | First part of the Pipedrive organization URL, i.e. `https://example-134554.pipedrive.com`\n| `ORBIT_API_KEY` | API key for Orbit | Found in `Account Settings` in your Orbit workspace\n| `ORBIT_WORKSPACE_ID` | ID for your Orbit workspace | Last part of the Orbit workspace URL, i.e. `https://app.orbit.love/my-workspace`, the ID is `my-workspace`\n\n## Package Usage\n\nInstall the package with the following command\n\n```\n$ gem install pipedrive_orbit\n```\n\nThen, run `bundle install` from your terminal.\n\nYou can instantiate a client by either passing in the required credentials during instantiation or by providing them in your `.env` file.\n\n### Instantiation with credentials:\n\n```ruby\nclient = PipedriveOrbit::Client.new(\n    orbit_api_key: YOUR_API_KEY,\n    orbit_workspace_id: YOUR_ORBIT_WORKSPACE_ID,\n    pipedrive_api_key: YOUR_PIPEDRIVE_API_KEY,\n    pipedrive_url: YOUR_PIPEDRIVE_URL\n)\n```\n\n### Instantiation with credentials in dotenv file:\n\n```ruby\nclient = PipedriveOrbit::Client.new\n```\n### Fetching Pipedrive Notes\n\nOnce, you have an instantiated client, you can fetch Pipedrive deal notes and send them to Orbit by invoking the `#notes` instance method:\n\n```ruby\nclient.notes\n```\n### Fetching Pipedrive Activities\n\nYou can fetch Pipedrive activities and send them to Orbit by invoking the `#activities` instance method:\n\n```ruby\nclient.activities\n```\n### Fetching Pipedrive Notes on People\n\nYou can fetch Pipedrive notes on people and send them to Orbit by invoking the `#people_notes` instance method:\n\n```ruby\nclient.people_notes\n```\n## CLI Usage\n\nYou can also use this package with the included CLI. To use the CLI pass in the required environment variables on the command line before invoking the CLI.\n\nTo check for new deal notes:\n\n```bash\n$ ORBIT_API_KEY=... ORBIT_WORKSPACE_ID=... PIPEDRIVE_API_KEY=... PIPEDRIVE_URL=... bundle exec pipedrive_orbit --check_notes\n```\n\nTo check for new activities:\n\n```bash\n$ ORBIT_API_KEY=... ORBIT_WORKSPACE_ID=... PIPEDRIVE_API_KEY=... PIPEDRIVE_URL=... bundle exec pipedrive_orbit --check_activities\n```\n\nTo check for new notes on people:\n\n```bash\n$ ORBIT_API_KEY=... ORBIT_WORKSPACE_ID=... PIPEDRIVE_API_KEY=... PIPEDRIVE_URL=... bundle exec pipedrive_orbit --check_people_notes\n```\n\n## GitHub Actions Automation Setup\n\n⚡ You can set up this integration in a matter of minutes using our GitHub Actions template. It will run regularly to add new activities to your Orbit workspace. All you need is a GitHub account.\n\n[See our guide for setting up this automation](https://github.com/orbit-love/github-actions-templates/blob/main/Pipedrive/README.md)\n\n## Contributing\n\nWe 💜 contributions from everyone! Check out the [Contributing Guidelines](.github/CONTRIBUTING.md) for more information.\n\n## License\n\nThis project is under the [MIT License](./LICENSE).\n\n## Code of Conduct\n\nThis project uses the [Contributor Code of Conduct](.github/CODE_OF_CONDUCT.md). We ask everyone to please adhere by its guidelines.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forbit-love%2Fcommunity-ruby-pipedrive-orbit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Forbit-love%2Fcommunity-ruby-pipedrive-orbit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forbit-love%2Fcommunity-ruby-pipedrive-orbit/lists"}