-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improves to providers documentation (#286)
- Loading branch information
Showing
4 changed files
with
62 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,9 @@ | ||
# Providers | ||
Providers are the backbone of the product and let you configure how your communications go out. Currently Parcelvoy supports four major types of communications: | ||
- Text Message | ||
- Push Notification | ||
- Webhook | ||
# Integrations | ||
Integrations are the backbone of Parcelvoy and let you configure how your communications go out. | ||
|
||
Between the four of those you should be able to handle just about anything. | ||
Integrations are project specific meaning if you have a test and production project, you can have each one setup to use different providers. | ||
|
||
Providers are project specific meaning if you have a test and production project, you can have each one setup to use different providers. | ||
|
||
<Tip>See the (providers section)[/providers] for more information on each of the provider types we support!</Tip> | ||
|
||
## Creating a Provider | ||
To create a provider, nagivate to `Settings -> Providers` under the project you want to add one to. From there click `Add Provider`. | ||
|
||
A modal will open which lets you pick from any of our currently supported providers. Selecting one will show you the required fields needed to setup that provider. | ||
|
||
Consult any of our (provider pages)[/providers] for more information on getting them setup. | ||
:::tip | ||
See the [providers section](/providers) for more information on the integrations available. | ||
::: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# PostHog | ||
Parcelvoy supports sending events to PostHog. Follow the instructions below to setup. | ||
|
||
1. Open [PostHog](https://app.posthog.com) and navigate to `Project settings` | ||
2. Scroll down to the `Project Variables` section and copy the `Project API Key` for later. | ||
4. Navigate to the Parcelvoy integrations page, hit `Add Integration` and select the `PostHog` integration. | ||
5. Enter the copied key into the `API Key` field. | ||
6. If you are self hosting, please enter the host URL of your installation, otherwise you can leave that field blank or enter `https://app.posthog.com` | ||
7. Check `Is Default` if you would like this to be where all analytic events are sent (this will override any other analytic integrations). | ||
8. Save the integration and events will start sending immediately. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,10 @@ | ||
# SMTP | ||
# SMTP | ||
You can use the SMTP integration to send emails over pretty much any email account out there. | ||
|
||
:::caution | ||
While it is super easy to use any inbox to send with SMTP, please note that most inboxes have low daily send limits. It's recommended that you use a provider meant for sending emails. | ||
::: | ||
|
||
1. Navigate to the Parcelvoy integrations page, hit `Add Integration` and select the `SMTP` integration. | ||
2. Fill in the `Host`, `Port` and authentication for your email account. | ||
3. Hit `Create Integration` |