From 50ed9e84e434c89dbcfff62866717cd23267b330 Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Mon, 29 Jan 2024 23:00:54 +0000 Subject: [PATCH 1/2] Add all providers --- src/routes/docs/Sidebar.svelte | 12 ++-- .../messaging/providers/+layout@.svelte | 10 +-- .../messaging/providers/+page.markdoc | 5 +- .../messaging/providers/apns/+page.markdoc | 4 +- .../messaging/providers/fcm/+page.markdoc | 55 +++++++++++++--- .../messaging/providers/mailgun/+page.markdoc | 64 +++++++++++++++++++ .../messaging/providers/msg91/+page.markdoc | 51 +++++++++++++++ .../providers/sendgrid/+page.markdoc | 64 +++++++++++++++++++ .../providers/telesign/+page.markdoc | 51 +++++++++++++++ .../providers/textmagic/+page.markdoc | 51 +++++++++++++++ .../messaging/providers/twilio/+page.markdoc | 51 +++++++++++++++ .../messaging/providers/vonage/+page.markdoc | 52 +++++++++++++++ 12 files changed, 446 insertions(+), 24 deletions(-) create mode 100644 src/routes/docs/products/messaging/providers/mailgun/+page.markdoc create mode 100644 src/routes/docs/products/messaging/providers/msg91/+page.markdoc create mode 100644 src/routes/docs/products/messaging/providers/sendgrid/+page.markdoc create mode 100644 src/routes/docs/products/messaging/providers/telesign/+page.markdoc create mode 100644 src/routes/docs/products/messaging/providers/textmagic/+page.markdoc create mode 100644 src/routes/docs/products/messaging/providers/twilio/+page.markdoc create mode 100644 src/routes/docs/products/messaging/providers/vonage/+page.markdoc diff --git a/src/routes/docs/Sidebar.svelte b/src/routes/docs/Sidebar.svelte index 5ab6faa8d3..aff37e840c 100644 --- a/src/routes/docs/Sidebar.svelte +++ b/src/routes/docs/Sidebar.svelte @@ -53,18 +53,18 @@ icon: 'icon-lightning-bolt', isParent: true }, + { + label: 'Messaging', + href: '/docs/products/messaging', + icon: 'icon-send', + isParent: true + }, { label: 'Storage', href: '/docs/products/storage', icon: 'icon-folder', isParent: true }, - { - label: 'Messaging', - href: '/docs/products/messaging', - icon: 'icon-send', - isParent: true - } ] }, { diff --git a/src/routes/docs/products/messaging/providers/+layout@.svelte b/src/routes/docs/products/messaging/providers/+layout@.svelte index c0177ecbfa..98cfbd68e5 100644 --- a/src/routes/docs/products/messaging/providers/+layout@.svelte +++ b/src/routes/docs/products/messaging/providers/+layout@.svelte @@ -13,7 +13,7 @@ items: [ { label: 'Overview', - href: '/docs/products/messaging' + href: '/docs/products/messaging/providers' }, ] }, @@ -22,11 +22,11 @@ items: [ { label: 'FCM', - href: '/docs/products/messaging/providers' + href: '/docs/products/messaging/providers/fcm' }, { label: 'APNs', - href: '/docs/products/messaging/targets' + href: '/docs/products/messaging/providers/apns' }, ] }, @@ -47,8 +47,8 @@ label: 'SMS', items: [ { - label: 'Twillio', - href: '/docs/products/messaging/providers/twillio' + label: 'Twilio', + href: '/docs/products/messaging/providers/twilio' }, { label: 'MSG91', diff --git a/src/routes/docs/products/messaging/providers/+page.markdoc b/src/routes/docs/products/messaging/providers/+page.markdoc index 1036e31e2a..f9d4c66dbc 100644 --- a/src/routes/docs/products/messaging/providers/+page.markdoc +++ b/src/routes/docs/products/messaging/providers/+page.markdoc @@ -2,6 +2,7 @@ layout: article title: Providers description: Learn the different providers that you can use to send messages with Appwrite. +back: /docs/products/messaging --- Appwrite allows you to connect to a variety of third-party messaging providers to deliver push notifications, emails, and SMS messages to your users. @@ -33,8 +34,8 @@ Deliver custom email messages to users using Sendgrid. # SMS {% #sms %} Send customized SMS messages to users by phone to send reminders, updates, promotions, and one-time passwords. {% cards %} -{% cards_item href="/docs/products/messaging/providers/twillio" title="Twillio" %} -Deliver custom SMS messages to users using Twillio. +{% cards_item href="/docs/products/messaging/providers/twilio" title="Twilio" %} +Deliver custom SMS messages to users using Twilio. {% /cards_item %} {% cards_item href="/docs/products/messaging/providers/msg91" title="MSG91" %} Deliver custom SMS messages to users using MSG91. diff --git a/src/routes/docs/products/messaging/providers/apns/+page.markdoc b/src/routes/docs/products/messaging/providers/apns/+page.markdoc index e13ce98d85..00eab47031 100644 --- a/src/routes/docs/products/messaging/providers/apns/+page.markdoc +++ b/src/routes/docs/products/messaging/providers/apns/+page.markdoc @@ -2,7 +2,7 @@ layout: article title: Apple Push Notification service description: Send push notifications to apps on Apple devices through Apple Push Notification service (APNs) using Appwrite Messaging. -back: /docs +back: /docs/products/messaging/providers --- Apple Push Notification service (APNs) lets you send push notifications to Apple devices like macOS, iOS, tvOS, iPadOS, and watchOS devices. @@ -11,7 +11,7 @@ APNs will save the last [N] messages for [M] days and attempt delivery as soon a {% section #add-provider step=1 title="Add provider" %} -To add APNs as a provier, navigate to **Messaging** > **Providers** > {% icon icon="plus" size="m" /%} **Add provider** > **Push notification**. +To add APNs as a provider, navigate to **Messaging** > **Providers** > {% icon icon="plus" size="m" /%} **Add provider** > **Push notification**. [SCREENSHOT] Give your provider a name > choose **APNS** > click **Save and continue**. diff --git a/src/routes/docs/products/messaging/providers/fcm/+page.markdoc b/src/routes/docs/products/messaging/providers/fcm/+page.markdoc index f779d594ce..47a374b8ec 100644 --- a/src/routes/docs/products/messaging/providers/fcm/+page.markdoc +++ b/src/routes/docs/products/messaging/providers/fcm/+page.markdoc @@ -1,14 +1,51 @@ --- layout: article -title: Apple Push Notification service -description: Send push notifications to apps on Apple devices through Apple Push Notification service (APNs) using Appwrite Messaging. -back: /docs +title: Firebase Cloud Messaging +description: Send push notifications to Android, Apple, or Web app with Firebase Cloud Messaging (FCM). +back: /docs/products/messaging/providers --- -Apple Push Notification service (APNs) lets you send push notifications to Apple devices like macOS, iOS, tvOS, iPadOS, and watchOS devices. -APNs is a best-effort service, and will attempt to deliver you messages to your device when it's online and available again. -APNs will save the last [N] messages for [M] days and attempt delivery as soon as it's online. +Firebase Cloud Messaging (FCM) lets you send push notifications to your iOS, Android, and web apps through Appwrite Messaging. +Before you can deliver messages, you must connect to a messaging provider. -# Add provider {% #add-provider %} -To add APNs as a provier, navigate to **Messaging** > **Providers** > {% icon icon="plus" /%} **Add provider** -[SCREENSHOT] \ No newline at end of file +{% section #add-provider step=1 title="Add provider" %} + +To add FCM as a provider, navigate to **Messaging** > **Providers** > {% icon icon="plus" size="m" /%} **Add provider** > **Push notification**. +[SCREENSHOT] + +Give your provider a name > choose **FCM** > click **Save and continue**. +The provider will be saved to your project, but not enabled until you complete its configuration. +{% /section %} +{% section #configure-provider step=2 title="Configure provider" %} + +In the **Configure** step, you will need to provide details form your Firebase console to connect your Appwrite project. + +[SCREENSHOT] + +You will need to provide the following information from the **Firebase console**. + +{% info title="Enable FCM" %} +FCM must be enabled on your Firebase project. + +Head to Firebase console -> Settings -> Project settings -> Cloud Messaging. +If FCM is disabled, click the three-dots menu and open the link. On the following page, click **Enable** (it might take a few minutes for the action to complete). +{% /info %} + +{% table %} +* Field name +* +--- +* Server key (.json file) +* Head to Project settings -> Service accounts -> Generate new private key. +{% /table %} + +After adding the following details, click **Save and continue** to enable the provider. +{% /section %} + +{% section #test-provider step=3 title="Test provider" %} +You can follow the [Send push notifications](TODO) journey to send your first push notification and test your provider. +{% /section %} + +{% section #manage-provider step=4 title="Manage provider" %} +[TODO: How to update and delete provider.] +{% /section %} diff --git a/src/routes/docs/products/messaging/providers/mailgun/+page.markdoc b/src/routes/docs/products/messaging/providers/mailgun/+page.markdoc new file mode 100644 index 0000000000..1b3bcf4516 --- /dev/null +++ b/src/routes/docs/products/messaging/providers/mailgun/+page.markdoc @@ -0,0 +1,64 @@ +--- +layout: article +title: Mailgun +description: Send emails to your Appwrite users using Mailgun and Appwrite Messaging. +back: /docs/products/messaging/providers +--- + +Mailgun lets you send customized email messages to your users. +These emails can be sent immediately or scheduled. +You can send emails for purposes like reminders, promotions, announcements, and even custom authentication flows. + +{% section #add-provider step=1 title="Add provider" %} + +To add Mailgun as a provider, navigate to **Messaging** > **Providers** > {% icon icon="plus" size="m" /%} **Add provider** > **Email**. +[SCREENSHOT] + +Give your provider a name > choose **Mailgun** > click **Save and continue**. +The provider will be saved to your project, but not enabled until you complete its configuration. +{% /section %} +{% section #configure-provider step=2 title="Configure provider" %} + +In the **Configure** step, you will need to provide details form your Mailgun dashboard to connect your Appwrite project. + +[SCREENSHOT] + +You will need to provide the following information from your **Mailgun dashboard**. + +{% table %} +* Field name +* +--- +* API key +* Head to Profile -> API Security -> Add new key. +--- +* Domain +* Head to Sending -> Domains -> Add new domain. +Follow [Mailgun's instructions](https://help.mailgun.com/hc/en-us/articles/360026833053-Domain-Verification-Walkthrough) to verify the domain name. +--- +* EU region +* Enable the EU region setting if your domain is within the European Union. +--- +* Sender email +* [TODO] +--- +* Sender name +* [TODO] +--- +* Reply-to email +* [TODO] +--- +* Reply-to name +* [TODO] +{% /table %} + +After adding the following details, click **Save and continue** to enable the provider. +{% /section %} + +{% section #test-provider step=3 title="Test provider" %} +You can follow the [Send push notifications](TODO) journey to send your first push notification and test your provider. +{% /section %} + +{% section #manage-provider step=4 title="Manage provider" %} +[TODO: How to update and delete provider.] +{% /section %} diff --git a/src/routes/docs/products/messaging/providers/msg91/+page.markdoc b/src/routes/docs/products/messaging/providers/msg91/+page.markdoc new file mode 100644 index 0000000000..6b830c7511 --- /dev/null +++ b/src/routes/docs/products/messaging/providers/msg91/+page.markdoc @@ -0,0 +1,51 @@ +--- +layout: article +title: MSG91 +description: Send SMS messages to your Appwrite users using MSG91 and Appwrite Messaging. +back: /docs/products/messaging/providers +--- + +MSG91 lets you send customized SMS messages to your users. +These SMS messages can be sent immediately or scheduled. +You can send SMS messages for purposes like reminders, promotions, announcements, and even custom authentication flows. + +{% section #add-provider step=1 title="Add provider" %} + +To add MSG91 as a provider, navigate to **Messaging** > **Providers** > {% icon icon="plus" size="m" /%} **Add provider** > **SMS**. +[SCREENSHOT] + +Give your provider a name > choose **MSG91** > click **Save and continue**. +The provider will be saved to your project, but not enabled until you complete its configuration. +{% /section %} +{% section #configure-provider step=2 title="Configure provider" %} + +In the **Configure** step, you will need to provide details form your MSG91 dashboard to connect your Appwrite project. + +[SCREENSHOT] + +You will need to provide the following information from your **MSG91 dashboard**. + +{% table %} +* Field name +* +--- +* Auth key +* Click to open the Username dropdown -> Authkey -> Verify your mobile number -> Create Authkey. +--- +* Sender ID +* Head to MSG91 dashboard -> SMS -> Sender ID -> Create sender ID. +--- +* Sender number +* [TODO] +{% /table %} + +After adding the following details, click **Save and continue** to enable the provider. +{% /section %} + +{% section #test-provider step=3 title="Test provider" %} +You can follow the [Send push notifications](TODO) journey to send your first push notification and test your provider. +{% /section %} + +{% section #manage-provider step=4 title="Manage provider" %} +[TODO: How to update and delete provider.] +{% /section %} diff --git a/src/routes/docs/products/messaging/providers/sendgrid/+page.markdoc b/src/routes/docs/products/messaging/providers/sendgrid/+page.markdoc new file mode 100644 index 0000000000..d36f87b991 --- /dev/null +++ b/src/routes/docs/products/messaging/providers/sendgrid/+page.markdoc @@ -0,0 +1,64 @@ +--- +layout: article +title: Sendgrid +description: Send emails to your Appwrite users using Sendgrid and Appwrite Messaging. +back: /docs/products/messaging/providers +--- + +Sendgrid lets you send customized email messages to your users. +These emails can be sent immediately or scheduled. +You can send emails for purposes like reminders, promotions, announcements, and even custom authentication flows. + +{% section #add-provider step=1 title="Add provider" %} + +To add Sendgrid as a provider, navigate to **Messaging** > **Providers** > {% icon icon="plus" size="m" /%} **Add provider** > **Email**. +[SCREENSHOT] + +Give your provider a name > choose **Sendgrid** > click **Save and continue**. +The provider will be saved to your project, but not enabled until you complete its configuration. +{% /section %} +{% section #configure-provider step=2 title="Configure provider" %} + +In the **Configure** step, you will need to provide details form your Sendgrid dashboard to connect your Appwrite project. + +[SCREENSHOT] + +You will need to provide the following information from your **Sendgrid dashboard**. + +{% table %} +* Field name +* +--- +* API key +* Head to Profile -> API Security -> Add new key. +--- +* Domain +* Head to Sending -> Domains -> Add new domain. +Follow [Mailgun's instructions](https://help.mailgun.com/hc/en-us/articles/360026833053-Domain-Verification-Walkthrough) to verify the domain name. +--- +* EU region +* Enable the EU region setting if your domain is within the European Union. +--- +* Sender email +* [TODO] +--- +* Sender name +* [TODO] +--- +* Reply-to email +* [TODO] +--- +* Reply-to name +* [TODO] +{% /table %} + +After adding the following details, click **Save and continue** to enable the provider. +{% /section %} + +{% section #test-provider step=3 title="Test provider" %} +You can follow the [Send push notifications](TODO) journey to send your first push notification and test your provider. +{% /section %} + +{% section #manage-provider step=4 title="Manage provider" %} +[TODO: How to update and delete provider.] +{% /section %} diff --git a/src/routes/docs/products/messaging/providers/telesign/+page.markdoc b/src/routes/docs/products/messaging/providers/telesign/+page.markdoc new file mode 100644 index 0000000000..85dce7fecd --- /dev/null +++ b/src/routes/docs/products/messaging/providers/telesign/+page.markdoc @@ -0,0 +1,51 @@ +--- +layout: article +title: Telesign +description: Send SMS messages to your Appwrite users using Telesign and Appwrite Messaging. +back: /docs/products/messaging/providers +--- + +Telesign lets you send customized SMS messages to your users. +These SMS messages can be sent immediately or scheduled. +You can send SMS messages for purposes like reminders, promotions, announcements, and even custom authentication flows. + +{% section #add-provider step=1 title="Add provider" %} + +To add Telesign as a provider, navigate to **Messaging** > **Providers** > {% icon icon="plus" size="m" /%} **Add provider** > **SMS**. +[SCREENSHOT] + +Give your provider a name > choose **Telesign** > click **Save and continue**. +The provider will be saved to your project, but not enabled until you complete its configuration. +{% /section %} +{% section #configure-provider step=2 title="Configure provider" %} + +In the **Configure** step, you will need to provide details form your Telesign dashboard to connect your Appwrite project. + +[SCREENSHOT] + +You will need to provide the following information from your **Telesign dashboard**. + +{% table %} +* Field name +* +--- +* [TODO] +* [TODO] +--- +* [TODO] +* [TODO] +--- +* [TODO] +* [TODO] +{% /table %} + +After adding the following details, click **Save and continue** to enable the provider. +{% /section %} + +{% section #test-provider step=3 title="Test provider" %} +You can follow the [Send push notifications](TODO) journey to send your first push notification and test your provider. +{% /section %} + +{% section #manage-provider step=4 title="Manage provider" %} +[TODO: How to update and delete provider.] +{% /section %} diff --git a/src/routes/docs/products/messaging/providers/textmagic/+page.markdoc b/src/routes/docs/products/messaging/providers/textmagic/+page.markdoc new file mode 100644 index 0000000000..fa37e2ed50 --- /dev/null +++ b/src/routes/docs/products/messaging/providers/textmagic/+page.markdoc @@ -0,0 +1,51 @@ +--- +layout: article +title: Text Magic +description: Send SMS messages to your Appwrite users using Text Magic and Appwrite Messaging. +back: /docs/products/messaging/providers +--- + +Text Magic lets you send customized SMS messages to your users. +These SMS messages can be sent immediately or scheduled. +You can send SMS messages for purposes like reminders, promotions, announcements, and even custom authentication flows. + +{% section #add-provider step=1 title="Add provider" %} + +To add Text Magic as a provider, navigate to **Messaging** > **Providers** > {% icon icon="plus" size="m" /%} **Add provider** > **SMS**. +[SCREENSHOT] + +Give your provider a name > choose **Text Magic** > click **Save and continue**. +The provider will be saved to your project, but not enabled until you complete its configuration. +{% /section %} +{% section #configure-provider step=2 title="Configure provider" %} + +In the **Configure** step, you will need to provide details form your Text Magic dashboard to connect your Appwrite project. + +[SCREENSHOT] + +You will need to provide the following information from your **Text Magic dashboard**. + +{% table %} +* Field name +* +--- +* API key +* Head to TextMagic dashboard > **Services** > **API** > **Add new API key**. +--- +* Username +* Head to TextMagic dashboard > **My account** > **Username**. +--- +* Sender number +* [TODO] +{% /table %} + +After adding the following details, click **Save and continue** to enable the provider. +{% /section %} + +{% section #test-provider step=3 title="Test provider" %} +You can follow the [Send push notifications](TODO) journey to send your first push notification and test your provider. +{% /section %} + +{% section #manage-provider step=4 title="Manage provider" %} +[TODO: How to update and delete provider.] +{% /section %} diff --git a/src/routes/docs/products/messaging/providers/twilio/+page.markdoc b/src/routes/docs/products/messaging/providers/twilio/+page.markdoc new file mode 100644 index 0000000000..791ad75918 --- /dev/null +++ b/src/routes/docs/products/messaging/providers/twilio/+page.markdoc @@ -0,0 +1,51 @@ +--- +layout: article +title: Twilio +description: Send SMS messages to your Appwrite users using Twilio and Appwrite Messaging. +back: /docs/products/messaging/providers +--- + +Twilio lets you send customized SMS messages to your users. +These SMS messages can be sent immediately or scheduled. +You can send SMS messages for purposes like reminders, promotions, announcements, and even custom authentication flows. + +{% section #add-provider step=1 title="Add provider" %} + +To add Twilio as a provider, navigate to **Messaging** > **Providers** > {% icon icon="plus" size="m" /%} **Add provider** > **SMS**. +[SCREENSHOT] + +Give your provider a name > choose **Twilio** > click **Save and continue**. +The provider will be saved to your project, but not enabled until you complete its configuration. +{% /section %} +{% section #configure-provider step=2 title="Configure provider" %} + +In the **Configure** step, you will need to provide details form your Twilio dashboard to connect your Appwrite project. + +[SCREENSHOT] + +You will need to provide the following information from your **Twilio dashboard**. + +{% table %} +* Field name +* +--- +* Account SID +* Head to Twilio console -> **Account info** -> **Account SID**. +--- +* Auth token +* Head to Twilio console -> **Account info** -> **Auth Token**. +--- +* Sender number +* You can access numbers by navigating to your Twilio console > **Develop** > **Phone Numbers** > **Manage** > **Active Numbers**. +{% /table %} + +After adding the following details, click **Save and continue** to enable the provider. +{% /section %} + +{% section #test-provider step=3 title="Test provider" %} +You can follow the [Send push notifications](TODO) journey to send your first push notification and test your provider. +{% /section %} + +{% section #manage-provider step=4 title="Manage provider" %} +[TODO: How to update and delete provider.] +{% /section %} diff --git a/src/routes/docs/products/messaging/providers/vonage/+page.markdoc b/src/routes/docs/products/messaging/providers/vonage/+page.markdoc new file mode 100644 index 0000000000..b310f8b74e --- /dev/null +++ b/src/routes/docs/products/messaging/providers/vonage/+page.markdoc @@ -0,0 +1,52 @@ +--- +layout: article +title: Vonage +description: Send SMS messages to your Appwrite users using Vonage and Appwrite Messaging. +back: /docs/products/messaging/providers +--- + +Vonage lets you send customized SMS messages to your users. +These SMS messages can be sent immediately or scheduled. +You can send SMS messages for purposes like reminders, promotions, announcements, and even custom authentication flows. + +{% section #add-provider step=1 title="Add provider" %} + +To add Vonage as a provider, navigate to **Messaging** > **Providers** > {% icon icon="plus" size="m" /%} **Add provider** > **SMS**. +[SCREENSHOT] + +Give your provider a name > choose **Vonage** > click **Save and continue**. +The provider will be saved to your project, but not enabled until you complete its configuration. +{% /section %} +{% section #configure-provider step=2 title="Configure provider" %} + +In the **Configure** step, you will need to provide details form your Vonage dashboard to connect your Appwrite project. + +[SCREENSHOT] + +You will need to provide the following information from your **Vonage dashboard**. + +{% table %} +* Field name +* +--- +* API key +* Head to Vonage dashboard > **Build & manage** > **API settings** and copy the API key. +--- +* API secret +* Head to Vonage dashboard > **Build & manage** > **API settings** and copy the API secret. +--- +* Sender number +* You can access your numbers by navigating to Vonage dashboard > **Build & manage** > **Numbers** > **Your numbers**. +--- +{% /table %} + +After adding the following details, click **Save and continue** to enable the provider. +{% /section %} + +{% section #test-provider step=3 title="Test provider" %} +You can follow the [Send push notifications](TODO) journey to send your first push notification and test your provider. +{% /section %} + +{% section #manage-provider step=4 title="Manage provider" %} +[TODO: How to update and delete provider.] +{% /section %} From 9fc9a023add19f1ec80ea8df3ece8943d871762b Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Tue, 30 Jan 2024 03:27:32 +0000 Subject: [PATCH 2/2] Added required code examples shells --- .../messaging/providers/apns/+page.markdoc | 39 +++++++++++++++++++ .../messaging/providers/fcm/+page.markdoc | 39 +++++++++++++++++++ .../messaging/providers/mailgun/+page.markdoc | 39 +++++++++++++++++++ .../messaging/providers/msg91/+page.markdoc | 39 +++++++++++++++++++ .../providers/sendgrid/+page.markdoc | 39 +++++++++++++++++++ .../providers/telesign/+page.markdoc | 39 +++++++++++++++++++ .../providers/textmagic/+page.markdoc | 39 +++++++++++++++++++ .../messaging/providers/twilio/+page.markdoc | 39 +++++++++++++++++++ .../messaging/providers/vonage/+page.markdoc | 39 +++++++++++++++++++ 9 files changed, 351 insertions(+) diff --git a/src/routes/docs/products/messaging/providers/apns/+page.markdoc b/src/routes/docs/products/messaging/providers/apns/+page.markdoc index 00eab47031..d442e89239 100644 --- a/src/routes/docs/products/messaging/providers/apns/+page.markdoc +++ b/src/routes/docs/products/messaging/providers/apns/+page.markdoc @@ -47,6 +47,45 @@ After adding the following details, click **Save and continue** to enable the pr {% /section %} {% section #test-provider step=3 title="Test provider" %} +Before sending your first message, +make sure you've configured [a topic](/docs/products/messaging/topic) and [a target](/docs/products/messaging/target) to send messages to. +{% tabs %} +{% tabsitem #console title="Console" %} +To send a test message, navigate to **Messaging** > **Messages** > {% icon icon="plus" size="m" /%} **Create message** > **Push notifcation**. +[SCREENSHOT] + +Add your message and in the targets step, select one of your test targets. Set the schedule to **Now** and click **Send**. + +Verify that you can receive the message in your inbox. If not +{% /tabsitem %} + +{% tabsitem #server-sdk title="Server SDK" %} +To send a message programmatically, use an [Appwrite Server SDK](/docs/sdks#server). +{% multicode %} +```js +``` +```deno +``` +```php +``` +```python +``` +```ruby +``` +```csharp +``` +```dart +``` +```kotlin +``` +```java +``` +```swift +``` +{% /multicode %} +{% /tabsitem %} +{% /tabs %} + You can follow the [Send push notifications](TODO) journey to send your first push notification and test your provider. {% /section %} diff --git a/src/routes/docs/products/messaging/providers/fcm/+page.markdoc b/src/routes/docs/products/messaging/providers/fcm/+page.markdoc index 47a374b8ec..ed54ec2da9 100644 --- a/src/routes/docs/products/messaging/providers/fcm/+page.markdoc +++ b/src/routes/docs/products/messaging/providers/fcm/+page.markdoc @@ -43,6 +43,45 @@ After adding the following details, click **Save and continue** to enable the pr {% /section %} {% section #test-provider step=3 title="Test provider" %} +Before sending your first message, +make sure you've configured [a topic](/docs/products/messaging/topic) and [a target](/docs/products/messaging/target) to send messages to. +{% tabs %} +{% tabsitem #console title="Console" %} +To send a test message, navigate to **Messaging** > **Messages** > {% icon icon="plus" size="m" /%} **Create message** > **Push notification**. +[SCREENSHOT] + +Add your message and in the targets step, select one of your test targets. Set the schedule to **Now** and click **Send**. + +Verify that you can receive the message in your inbox. If not +{% /tabsitem %} + +{% tabsitem #server-sdk title="Server SDK" %} +To send a message programmatically, use an [Appwrite Server SDK](/docs/sdks#server). +{% multicode %} +```js +``` +```deno +``` +```php +``` +```python +``` +```ruby +``` +```csharp +``` +```dart +``` +```kotlin +``` +```java +``` +```swift +``` +{% /multicode %} +{% /tabsitem %} +{% /tabs %} + You can follow the [Send push notifications](TODO) journey to send your first push notification and test your provider. {% /section %} diff --git a/src/routes/docs/products/messaging/providers/mailgun/+page.markdoc b/src/routes/docs/products/messaging/providers/mailgun/+page.markdoc index 1b3bcf4516..dff9b3f3b8 100644 --- a/src/routes/docs/products/messaging/providers/mailgun/+page.markdoc +++ b/src/routes/docs/products/messaging/providers/mailgun/+page.markdoc @@ -56,6 +56,45 @@ After adding the following details, click **Save and continue** to enable the pr {% /section %} {% section #test-provider step=3 title="Test provider" %} +Before sending your first message, +make sure you've configured [a topic](/docs/products/messaging/topic) and [a target](/docs/products/messaging/target) to send messages to. +{% tabs %} +{% tabsitem #console title="Console" %} +To send a test message, navigate to **Messaging** > **Messages** > {% icon icon="plus" size="m" /%} **Create message** > **Email**. +[SCREENSHOT] + +Add your message and in the targets step, select one of your test targets. Set the schedule to **Now** and click **Send**. + +Verify that you can receive the message in your inbox. If not +{% /tabsitem %} + +{% tabsitem #server-sdk title="Server SDK" %} +To send a message programmatically, use an [Appwrite Server SDK](/docs/sdks#server). +{% multicode %} +```js +``` +```deno +``` +```php +``` +```python +``` +```ruby +``` +```csharp +``` +```dart +``` +```kotlin +``` +```java +``` +```swift +``` +{% /multicode %} +{% /tabsitem %} +{% /tabs %} + You can follow the [Send push notifications](TODO) journey to send your first push notification and test your provider. {% /section %} diff --git a/src/routes/docs/products/messaging/providers/msg91/+page.markdoc b/src/routes/docs/products/messaging/providers/msg91/+page.markdoc index 6b830c7511..b0711b98cc 100644 --- a/src/routes/docs/products/messaging/providers/msg91/+page.markdoc +++ b/src/routes/docs/products/messaging/providers/msg91/+page.markdoc @@ -43,6 +43,45 @@ After adding the following details, click **Save and continue** to enable the pr {% /section %} {% section #test-provider step=3 title="Test provider" %} +Before sending your first message, +make sure you've configured [a topic](/docs/products/messaging/topic) and [a target](/docs/products/messaging/target) to send messages to. +{% tabs %} +{% tabsitem #console title="Console" %} +To send a test message, navigate to **Messaging** > **Messages** > {% icon icon="plus" size="m" /%} **Create message** > **SMS**. +[SCREENSHOT] + +Add your message and in the targets step, select one of your test targets. Set the schedule to **Now** and click **Send**. + +Verify that you can receive the message in your inbox. If not +{% /tabsitem %} + +{% tabsitem #server-sdk title="Server SDK" %} +To send a message programmatically, use an [Appwrite Server SDK](/docs/sdks#server). +{% multicode %} +```js +``` +```deno +``` +```php +``` +```python +``` +```ruby +``` +```csharp +``` +```dart +``` +```kotlin +``` +```java +``` +```swift +``` +{% /multicode %} +{% /tabsitem %} +{% /tabs %} + You can follow the [Send push notifications](TODO) journey to send your first push notification and test your provider. {% /section %} diff --git a/src/routes/docs/products/messaging/providers/sendgrid/+page.markdoc b/src/routes/docs/products/messaging/providers/sendgrid/+page.markdoc index d36f87b991..b5373580b6 100644 --- a/src/routes/docs/products/messaging/providers/sendgrid/+page.markdoc +++ b/src/routes/docs/products/messaging/providers/sendgrid/+page.markdoc @@ -56,6 +56,45 @@ After adding the following details, click **Save and continue** to enable the pr {% /section %} {% section #test-provider step=3 title="Test provider" %} +Before sending your first message, +make sure you've configured [a topic](/docs/products/messaging/topic) and [a target](/docs/products/messaging/target) to send messages to. +{% tabs %} +{% tabsitem #console title="Console" %} +To send a test message, navigate to **Messaging** > **Messages** > {% icon icon="plus" size="m" /%} **Create message** > **Email**. +[SCREENSHOT] + +Add your message and in the targets step, select one of your test targets. Set the schedule to **Now** and click **Send**. + +Verify that you can receive the message in your inbox. If not +{% /tabsitem %} + +{% tabsitem #server-sdk title="Server SDK" %} +To send a message programmatically, use an [Appwrite Server SDK](/docs/sdks#server). +{% multicode %} +```js +``` +```deno +``` +```php +``` +```python +``` +```ruby +``` +```csharp +``` +```dart +``` +```kotlin +``` +```java +``` +```swift +``` +{% /multicode %} +{% /tabsitem %} +{% /tabs %} + You can follow the [Send push notifications](TODO) journey to send your first push notification and test your provider. {% /section %} diff --git a/src/routes/docs/products/messaging/providers/telesign/+page.markdoc b/src/routes/docs/products/messaging/providers/telesign/+page.markdoc index 85dce7fecd..facc241ffa 100644 --- a/src/routes/docs/products/messaging/providers/telesign/+page.markdoc +++ b/src/routes/docs/products/messaging/providers/telesign/+page.markdoc @@ -43,6 +43,45 @@ After adding the following details, click **Save and continue** to enable the pr {% /section %} {% section #test-provider step=3 title="Test provider" %} +Before sending your first message, +make sure you've configured [a topic](/docs/products/messaging/topic) and [a target](/docs/products/messaging/target) to send messages to. +{% tabs %} +{% tabsitem #console title="Console" %} +To send a test message, navigate to **Messaging** > **Messages** > {% icon icon="plus" size="m" /%} **Create message** > **SMS**. +[SCREENSHOT] + +Add your message and in the targets step, select one of your test targets. Set the schedule to **Now** and click **Send**. + +Verify that you can receive the message in your inbox. If not +{% /tabsitem %} + +{% tabsitem #server-sdk title="Server SDK" %} +To send a message programmatically, use an [Appwrite Server SDK](/docs/sdks#server). +{% multicode %} +```js +``` +```deno +``` +```php +``` +```python +``` +```ruby +``` +```csharp +``` +```dart +``` +```kotlin +``` +```java +``` +```swift +``` +{% /multicode %} +{% /tabsitem %} +{% /tabs %} + You can follow the [Send push notifications](TODO) journey to send your first push notification and test your provider. {% /section %} diff --git a/src/routes/docs/products/messaging/providers/textmagic/+page.markdoc b/src/routes/docs/products/messaging/providers/textmagic/+page.markdoc index fa37e2ed50..07cc419ea2 100644 --- a/src/routes/docs/products/messaging/providers/textmagic/+page.markdoc +++ b/src/routes/docs/products/messaging/providers/textmagic/+page.markdoc @@ -43,6 +43,45 @@ After adding the following details, click **Save and continue** to enable the pr {% /section %} {% section #test-provider step=3 title="Test provider" %} +Before sending your first message, +make sure you've configured [a topic](/docs/products/messaging/topic) and [a target](/docs/products/messaging/target) to send messages to. +{% tabs %} +{% tabsitem #console title="Console" %} +To send a test message, navigate to **Messaging** > **Messages** > {% icon icon="plus" size="m" /%} **Create message** > **SMS**. +[SCREENSHOT] + +Add your message and in the targets step, select one of your test targets. Set the schedule to **Now** and click **Send**. + +Verify that you can receive the message in your inbox. If not +{% /tabsitem %} + +{% tabsitem #server-sdk title="Server SDK" %} +To send a message programmatically, use an [Appwrite Server SDK](/docs/sdks#server). +{% multicode %} +```js +``` +```deno +``` +```php +``` +```python +``` +```ruby +``` +```csharp +``` +```dart +``` +```kotlin +``` +```java +``` +```swift +``` +{% /multicode %} +{% /tabsitem %} +{% /tabs %} + You can follow the [Send push notifications](TODO) journey to send your first push notification and test your provider. {% /section %} diff --git a/src/routes/docs/products/messaging/providers/twilio/+page.markdoc b/src/routes/docs/products/messaging/providers/twilio/+page.markdoc index 791ad75918..10f939a404 100644 --- a/src/routes/docs/products/messaging/providers/twilio/+page.markdoc +++ b/src/routes/docs/products/messaging/providers/twilio/+page.markdoc @@ -43,6 +43,45 @@ After adding the following details, click **Save and continue** to enable the pr {% /section %} {% section #test-provider step=3 title="Test provider" %} +Before sending your first message, +make sure you've configured [a topic](/docs/products/messaging/topic) and [a target](/docs/products/messaging/target) to send messages to. +{% tabs %} +{% tabsitem #console title="Console" %} +To send a test message, navigate to **Messaging** > **Messages** > {% icon icon="plus" size="m" /%} **Create message** > **SMS**. +[SCREENSHOT] + +Add your message and in the targets step, select one of your test targets. Set the schedule to **Now** and click **Send**. + +Verify that you can receive the message in your inbox. If not +{% /tabsitem %} + +{% tabsitem #server-sdk title="Server SDK" %} +To send a message programmatically, use an [Appwrite Server SDK](/docs/sdks#server). +{% multicode %} +```js +``` +```deno +``` +```php +``` +```python +``` +```ruby +``` +```csharp +``` +```dart +``` +```kotlin +``` +```java +``` +```swift +``` +{% /multicode %} +{% /tabsitem %} +{% /tabs %} + You can follow the [Send push notifications](TODO) journey to send your first push notification and test your provider. {% /section %} diff --git a/src/routes/docs/products/messaging/providers/vonage/+page.markdoc b/src/routes/docs/products/messaging/providers/vonage/+page.markdoc index b310f8b74e..7c1527808a 100644 --- a/src/routes/docs/products/messaging/providers/vonage/+page.markdoc +++ b/src/routes/docs/products/messaging/providers/vonage/+page.markdoc @@ -44,6 +44,45 @@ After adding the following details, click **Save and continue** to enable the pr {% /section %} {% section #test-provider step=3 title="Test provider" %} +Before sending your first message, +make sure you've configured [a topic](/docs/products/messaging/topic) and [a target](/docs/products/messaging/target) to send messages to. +{% tabs %} +{% tabsitem #console title="Console" %} +To send a test message, navigate to **Messaging** > **Messages** > {% icon icon="plus" size="m" /%} **Create message** > **Email**. +[SCREENSHOT] + +Add your message and in the targets step, select one of your test targets. Set the schedule to **Now** and click **Send**. + +Verify that you can receive the message in your inbox. If not +{% /tabsitem %} + +{% tabsitem #server-sdk title="Server SDK" %} +To send a message programmatically, use an [Appwrite Server SDK](/docs/sdks#server). +{% multicode %} +```js +``` +```deno +``` +```php +``` +```python +``` +```ruby +``` +```csharp +``` +```dart +``` +```kotlin +``` +```java +``` +```swift +``` +{% /multicode %} +{% /tabsitem %} +{% /tabs %} + You can follow the [Send push notifications](TODO) journey to send your first push notification and test your provider. {% /section %}