https://github.com/sparkpost/sp-forwarding-service

A small Heroku service that will consume inbound message webhook POSTs and forward them through SparkPost.
https://github.com/sparkpost/sp-forwarding-service

Last synced: 10 months ago
JSON representation

A small Heroku service that will consume inbound message webhook POSTs and forward them through SparkPost.

• Host: GitHub
• URL: https://github.com/sparkpost/sp-forwarding-service
• Owner: SparkPost
• License: other
• Created: 2016-03-04T16:49:00.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2016-10-07T09:02:56.000Z (over 9 years ago)
• Last Synced: 2025-04-13T12:25:59.147Z (about 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 30.3 KB
• Stars: 8
• Watchers: 6
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# SparkPost Forwarding Service

A small Heroku service that will consume inbound message webhook POSTs and

forward them through the Transmissions API to a mailbox.

## Deployment

Start by clicking on the following button:

[![Deploy](https://www.herokucdn.com/deploy/button.svg)][deploy]

Once the deployment completes click on the "View" button under "Your app was

successfully deployed". (Alternatively browse to

`https://.herokuapp.com/index.html`.)

If a `FORWARD_FROM` address was chosen other than the default

`forward@sparkpostbox.com` then a sending domain will need to be

[created][createsd] and verified. To get to the SparkPost UI browse to the

"Resources" tab of the newly created app in the [Heroku Dashboard][apps], and

then click "SparkPost".

## Deploying Manually

1.  Register for an account with [Heroku][signup] and install the Heroku

    [Toolbelt][toolbelt] for your operating system. Then log in:

        heroku login

2.  Clone the repository and install:

        git clone git@github.com:SparkPost/sp-forwarding-service.git

        cd sp-forwarding-service

        npm install

3.  Create the heroku app:

        heroku create

4.  Configure the required add-ons:

        heroku addons:create heroku-redis:hobby-dev

        heroku addons:create sparkpost:free

    Note: The SparkPost add-on will automatically create a SparkPost account and

    set up the appropriate key. If you already have an account and wish to use

    that do not run the `addons:create sparkpost:free` command. Then set the

    following config var:

        heroku config:set SPARKPOST_API_KEY=

5.  Configure the app:

        heroku config:set FORWARD_FROM=

        heroku config:set FORWARD_TO=

6.  Deploy the app:

        git push heroku master

7.  Complete the setup by browsing to the following page:

        curl https://.herokuapp.com/index.html

[deploy]: https://heroku.com/deploy?template=https://github.com/SparkPost/sp-forwarding-service

[createsd]: https://support.sparkpost.com/customer/portal/articles/1933318

[apps]: https://dashboard.heroku.com/apps

[signup]: https://signup.heroku.com

[toolbelt]: https://toolbelt.heroku.com