https://github.com/orbit-love/community-ruby-pipedrive-orbit
Integrate Pipedrive activities into your Orbit workspace
https://github.com/orbit-love/community-ruby-pipedrive-orbit
api community crm orbit pipedrive pipedrive-api ruby rubygem
Last synced: about 1 year ago
JSON representation
Integrate Pipedrive activities into your Orbit workspace
- Host: GitHub
- URL: https://github.com/orbit-love/community-ruby-pipedrive-orbit
- Owner: orbit-love
- License: mit
- Created: 2021-05-13T13:59:05.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-08-24T01:37:47.000Z (almost 3 years ago)
- Last Synced: 2025-04-19T05:16:45.036Z (about 1 year ago)
- Topics: api, community, crm, orbit, pipedrive, pipedrive-api, ruby, rubygem
- Language: Ruby
- Homepage:
- Size: 164 KB
- Stars: 6
- Watchers: 4
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Pipedrive Interactions to Orbit Workspace
[](https://badge.fury.io/rb/pipedrive_orbit)
[](.github/CODE_OF_CONDUCT.md)
Add your Pipedrive CRM interactions into your Orbit workspace with this community-built integration.
|
:sparkles:
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.
We welcome community contributions to make sure that it stays current. :sparkles:
|
|-----------------------------------------|
## First Time Setup
To 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.
## Application Credentials
The application requires the following environment variables:
| Variable | Description | More Info
|---|---|--|
| `PIPEDRIVE_API_KEY` | API key for Pipedrive | Found in `Personal Preferences -> API` in your Pipedrive user settings
| `PIPEDRIVE_URL` | Organizational Pipedrive URL | First part of the Pipedrive organization URL, i.e. `https://example-134554.pipedrive.com`
| `ORBIT_API_KEY` | API key for Orbit | Found in `Account Settings` in your Orbit workspace
| `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`
## Package Usage
Install the package with the following command
```
$ gem install pipedrive_orbit
```
Then, run `bundle install` from your terminal.
You can instantiate a client by either passing in the required credentials during instantiation or by providing them in your `.env` file.
### Instantiation with credentials:
```ruby
client = PipedriveOrbit::Client.new(
orbit_api_key: YOUR_API_KEY,
orbit_workspace_id: YOUR_ORBIT_WORKSPACE_ID,
pipedrive_api_key: YOUR_PIPEDRIVE_API_KEY,
pipedrive_url: YOUR_PIPEDRIVE_URL
)
```
### Instantiation with credentials in dotenv file:
```ruby
client = PipedriveOrbit::Client.new
```
### Fetching Pipedrive Notes
Once, you have an instantiated client, you can fetch Pipedrive deal notes and send them to Orbit by invoking the `#notes` instance method:
```ruby
client.notes
```
### Fetching Pipedrive Activities
You can fetch Pipedrive activities and send them to Orbit by invoking the `#activities` instance method:
```ruby
client.activities
```
### Fetching Pipedrive Notes on People
You can fetch Pipedrive notes on people and send them to Orbit by invoking the `#people_notes` instance method:
```ruby
client.people_notes
```
## CLI Usage
You 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.
To check for new deal notes:
```bash
$ ORBIT_API_KEY=... ORBIT_WORKSPACE_ID=... PIPEDRIVE_API_KEY=... PIPEDRIVE_URL=... bundle exec pipedrive_orbit --check_notes
```
To check for new activities:
```bash
$ ORBIT_API_KEY=... ORBIT_WORKSPACE_ID=... PIPEDRIVE_API_KEY=... PIPEDRIVE_URL=... bundle exec pipedrive_orbit --check_activities
```
To check for new notes on people:
```bash
$ ORBIT_API_KEY=... ORBIT_WORKSPACE_ID=... PIPEDRIVE_API_KEY=... PIPEDRIVE_URL=... bundle exec pipedrive_orbit --check_people_notes
```
## GitHub Actions Automation Setup
⚡ 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.
[See our guide for setting up this automation](https://github.com/orbit-love/github-actions-templates/blob/main/Pipedrive/README.md)
## Contributing
We 💜 contributions from everyone! Check out the [Contributing Guidelines](.github/CONTRIBUTING.md) for more information.
## License
This project is under the [MIT License](./LICENSE).
## Code of Conduct
This project uses the [Contributor Code of Conduct](.github/CODE_OF_CONDUCT.md). We ask everyone to please adhere by its guidelines.