https://github.com/teradata/segment-webhook
GCP Cloud Run app that implements Twilio Segment's webhook interface
https://github.com/teradata/segment-webhook
Last synced: about 1 year ago
JSON representation
GCP Cloud Run app that implements Twilio Segment's webhook interface
- Host: GitHub
- URL: https://github.com/teradata/segment-webhook
- Owner: Teradata
- License: mit
- Created: 2021-12-09T15:31:16.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-17T18:16:25.000Z (about 4 years ago)
- Last Synced: 2025-04-13T09:14:11.371Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 95.7 KB
- Stars: 0
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# segment-webhook
GCP Cloud Run project that implements Twilio Segment's webhook interface. The component can be used by Teradata to create a Segment-native destination. Such destination would allow Teradata customers to move data from Segment to Teradata. The component is not generally available yet. If you are looking to integrate with Segment today, see https://github.com/Teradata/segment-integration-tutorial.
## Overview
The app takes calls from Twilio Segment and writes data to a Vantage instance.
## Deployment
### Prerequsites
1. A GCP account. If you don't have an account, you can create one at https://console.cloud.google.com/.
2. `gcloud` installed. See https://cloud.google.com/sdk/docs/install.
3. `Cloud Run` and dependent services enabled (`gcloud services enable cloudbuild.googleapis.com containerregistry.googleapis.com run.googleapis.com secretmanager.googleapis.com`).
4. Vantage Express instance exposed to the Internet. For details, see [the "Run Vantage Express on GCP" guide](https://quickstarts.teradata.com/docs/17.10/vantage.express.gcp.html).
### Build and deploy
1. Create a Vantage Express instance and expose it to the Internet. For example, see [Run Vantage Express on GCP](https://quickstarts.teradata.com/docs/17.10/vantage.express.gcp.html).
1. Clone this repository:
```bash
git clone git@github.com:Teradata/segment-webhook.git
```
1. Run `segment.sql` on your Vantage db using your favorite SQL IDE or Vantage command line tool called `bteq`. The SQL script will create a new database called `Segment` and a set of tables to store Segment events.
1. Build the application (replace `` with your GCP project id):
```bash
gcloud builds submit --tag gcr.io//webhook-segment
```
1. Define an API key that you will share with Segment. Store the API key in GCP Secret Manager:
```bash
gcloud secrets create API_KEY_SECRET
cat << EOF > /tmp/api_key.txt
a_very_long_and_secure_api_key_that_you_should_change
EOF
gcloud secrets versions add API_KEY_SECRET --data-file=/tmp/api_key.txt
gcloud secrets create VANTAGE_USER_SECRET
cat << EOF > /tmp/vantage_user.txt
dbc
EOF
gcloud secrets versions add VANTAGE_USER_SECRET --data-file=/tmp/vantage_user.txt
gcloud secrets create VANTAGE_PASSWORD_SECRET
cat << EOF > /tmp/vantage_password.txt
dbc
EOF
gcloud secrets versions add VANTAGE_PASSWORD_SECRET --data-file=/tmp/vantage_password.txt
```
1. Deploy the app to cloud run (replace `` with your GCP project id, `, <*_SECRET:VERSION>` with values for your environment):
```bash
gcloud run deploy --image gcr.io//webhook-segment webhook-segment \
--region us-central1 \
--allow-unauthenticated \
--update-env-vars VANTAGE_HOST= \
--update-secrets 'API_KEY=,VANTAGE_USER=, VANTAGE_PASSWORD='
```
1. Configure Teradata Vantage as a destination in Segment.
## Limitations
* Inbound security relies on sharing an API key between Segment and the Cloud Run app. Ideally, your Cloud Run service would be behind a WAF like Cloud Run, to allow connectivity only from Segment's IP addresses.
* The example shows how to deploy the app in a single region. In many cases, this setup doesn't guarantee enough uptime. The app should be deployed in more than one region behind a Global Load Balancer.