From f25b67c81c9e200cb79b35a8cbbfa07c4f79cadd Mon Sep 17 00:00:00 2001 From: Pierre Maurice Schwang Date: Mon, 28 Nov 2022 19:24:51 +0100 Subject: [PATCH] docs: add documentation for stripe connection / triggers --- packages/docs/pages/.vitepress/config.js | 8 ++++++++ packages/docs/pages/apps/stripe/connection.md | 14 ++++++++++++++ packages/docs/pages/apps/stripe/triggers.md | 18 ++++++++++++++++++ packages/docs/pages/guide/available-apps.md | 1 + packages/docs/pages/public/favicons/stripe.svg | 10 ++++++++++ 5 files changed, 51 insertions(+) create mode 100644 packages/docs/pages/apps/stripe/connection.md create mode 100644 packages/docs/pages/apps/stripe/triggers.md create mode 100644 packages/docs/pages/public/favicons/stripe.svg diff --git a/packages/docs/pages/.vitepress/config.js b/packages/docs/pages/.vitepress/config.js index 118ebfd1..1ea35237 100644 --- a/packages/docs/pages/.vitepress/config.js +++ b/packages/docs/pages/.vitepress/config.js @@ -105,6 +105,14 @@ export default defineConfig({ { text: 'Connection', link: '/apps/smtp/connection' }, ], }, + { + text: 'Stripe', + collapsible: true, + items: [ + { text: 'Triggers', link: '/apps/stripe/triggers' }, + { text: 'Connection', link: '/apps/stripe/connection' }, + ], + }, { text: 'Twilio', collapsible: true, diff --git a/packages/docs/pages/apps/stripe/connection.md b/packages/docs/pages/apps/stripe/connection.md new file mode 100644 index 00000000..738520ce --- /dev/null +++ b/packages/docs/pages/apps/stripe/connection.md @@ -0,0 +1,14 @@ +# Stripe + +:::info +This page explains the steps you need to follow to set up the Stripe connection in Automatisch. If any of the steps are outdated, please let us know! +::: + +:::info +You are free to use the **Testing secret key** instead of the productive secret key as well. +::: + +1. Go to the [Stripe Dashboard > Developer > API keys](https://dashboard.stripe.com/apikeys) +2. Click on **Reveal live key** in the table row **Secret key** and copy the now shown secret key 3 +3. Paste the **Secret key** in the named field in Automatisch and assign a display name for the connection. +4. Congrats! You can start using the new Stripe connection! diff --git a/packages/docs/pages/apps/stripe/triggers.md b/packages/docs/pages/apps/stripe/triggers.md new file mode 100644 index 00000000..92466ef9 --- /dev/null +++ b/packages/docs/pages/apps/stripe/triggers.md @@ -0,0 +1,18 @@ +--- +favicon: /favicons/stripe.svg +items: + - name: Payout + desc: Triggers when stripe sent a payout to a third-party bank account or vice versa. + org: Stripe Documentation + orgLink: https://stripe.com/docs/api/payouts/object + - name: Balance Transaction + desc: Triggers when a fund has been moved through your stripe account. + org: Stripe Documentation + orgLink: https://stripe.com/docs/api/balance_transactions/object +--- + + + + diff --git a/packages/docs/pages/guide/available-apps.md b/packages/docs/pages/guide/available-apps.md index 854d92e7..5697771f 100644 --- a/packages/docs/pages/guide/available-apps.md +++ b/packages/docs/pages/guide/available-apps.md @@ -15,5 +15,6 @@ Following integrations are currently supported by Automatisch. - [Scheduler](/apps/scheduler/triggers) - [Slack](/apps/slack/actions) - [SMTP](/apps/smtp/actions) +- [Stripe](/apps/stripe/triggers) - [Twilio](/apps/twilio/triggers) - [Twitter](/apps/twitter/triggers) diff --git a/packages/docs/pages/public/favicons/stripe.svg b/packages/docs/pages/public/favicons/stripe.svg new file mode 100644 index 00000000..25d00aaa --- /dev/null +++ b/packages/docs/pages/public/favicons/stripe.svg @@ -0,0 +1,10 @@ + + + + + + \ No newline at end of file