Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dxw/golden-retriever
Imports opportunities from the Digital Marketplace into Hubspot
https://github.com/dxw/golden-retriever
delivery-plus sales
Last synced: 21 days ago
JSON representation
Imports opportunities from the Digital Marketplace into Hubspot
- Host: GitHub
- URL: https://github.com/dxw/golden-retriever
- Owner: dxw
- Created: 2019-03-15T10:36:18.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-06-01T09:57:25.000Z (over 1 year ago)
- Last Synced: 2023-06-01T11:00:48.729Z (over 1 year ago)
- Topics: delivery-plus, sales
- Language: Ruby
- Homepage:
- Size: 2.5 MB
- Stars: 0
- Watchers: 12
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://github.com/dxw/golden_retriever/actions)
# Golden Retriever
Golden Retriever imports opportuntities from the [Digital Marketplace](https://www.digitalmarketplace.service.gov.uk/digital-outcomes-and-specialists/opportunities) into Hubspot and drops an alert into our Slack like this:
It is run every weekday at 9am (UTC) via a [Github Action](https://github.com/dxw/golden-retriever/blob/master/.github/workflows/run.yml).
## Getting started
Clone the repo:
```bash
git clone [email protected]:dxw/golden-retriever.git
```
Run the setup script:
```bash
script/setup
```
This script installs all the necessary dependencies and sets up all the required
environment variables detailed in [.env.example](https://github.com/dxw/golden-retriever/blob/master/.env.example), so make sure you have these to hand ([More on environment variables](https://github.com/dxw/golden-retriever#environment-variables)).
## Environment Variables
You must have the following required environment variables set in the `.env` file for
the application to function as expected:
- `HUBSPOT_API_KEY`: The API key for your Hubspot instance. This can be retrieved / generated in Hubspot in Settings > Integrations > API Key
- `HUBSPOT_PORTAL_ID`: The ID of the Hubspot portal that you want to import the opportunities into. You can see this below the name of your portal when logged into Hubspot
- `SLACK_WEBHOOK_URL`: The Slack Webhook that you will use to send a Slack notification once the import has run successfully. This should start with `https://hooks.slack.com`. [More on Slack webbooks](https://api.slack.com/messaging/webhooks)
- `HUBSPOT_PIPELINE_ID`: The ID of the Hubspot pipeline you want to import into. You can see a list of all your pipelines and their IDs via the [Hubspot API](https://developers.hubspot.com/docs/api/crm/pipelines)
- `HUBSPOT_DEAL_STAGE_ID`: The ID of the Hubspot deal stage you want to import into (this will probably be something like "For review"). You can see a list of all your deal stages and their IDs via the [Hubspot API](https://developers.hubspot.com/docs/api/crm/pipelines)
- `HUBSPOT_LIST_ID`: The ID of the Hubspot list that you want the Slack Notification to link to. This will probably be a filter you've set to view all deals that are marked "for review". You can get this from a list's URL once it's been set up (in the format `https://app.hubspot.com/contacts/PORTAL_ID/deals/list/view/LIST_ID/`)
## Running
To import the newest opportunities run the following:
```bash
bundle exec rake opportunities:import
```
You'll probably want to run this as a daily scheduled task. We use [Github Actions](https://github.com/dxw/golden-retriever/blob/master/.github/workflows/run.yml) for this