From 4bcab3761f91b9ba3111acc237ce219df5798b16 Mon Sep 17 00:00:00 2001 From: Devin Date: Tue, 9 Jan 2024 19:08:48 -0330 Subject: [PATCH 1/3] Created faq --- docs/faq/_category_.json | 4 ++++ docs/faq/faq.md | 7 +++++++ 2 files changed, 11 insertions(+) create mode 100644 docs/faq/_category_.json create mode 100644 docs/faq/faq.md diff --git a/docs/faq/_category_.json b/docs/faq/_category_.json new file mode 100644 index 00000000..d1d4635c --- /dev/null +++ b/docs/faq/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "FAQ", + "position": 10 +} \ No newline at end of file diff --git a/docs/faq/faq.md b/docs/faq/faq.md new file mode 100644 index 00000000..0a3d2e6f --- /dev/null +++ b/docs/faq/faq.md @@ -0,0 +1,7 @@ +# Frequently Asked Questions (FAQ) + +## Why Can I Not Send Notifications from a Front-end SDK? + +NotificationAPI front-end SDKs require your `clientId` and `clientSecret` keys that are unique to your account. If anyone else obtained your keys then they would be able to edit or delete your notifications, and be able to send requests to NotificationAPI from your account. This is a security risk to you and your clients. + +To better protect you, the NotificationAPI front-end SDKs do not allow _sending_ notifications: they only allow _receiving_ notifications. If you require sending notifications from your front-end, it is recommended to use a NotificationAPI back-end SDK on your back-end and expose an API for your front-end. \ No newline at end of file From c5a1ad927f88e71e2560393a79c85e06a3c95d3b Mon Sep 17 00:00:00 2001 From: Devin Date: Tue, 9 Jan 2024 19:09:39 -0330 Subject: [PATCH 2/3] Fixed sidebar positioning of faq --- docs/faq/_category_.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/faq/_category_.json b/docs/faq/_category_.json index d1d4635c..98ca18ea 100644 --- a/docs/faq/_category_.json +++ b/docs/faq/_category_.json @@ -1,4 +1,4 @@ { "label": "FAQ", - "position": 10 + "position": 8 } \ No newline at end of file From 031e78eee8fd96724632a2f2fa124622306eb232 Mon Sep 17 00:00:00 2001 From: Devin Date: Wed, 10 Jan 2024 10:59:59 -0330 Subject: [PATCH 3/3] PR comments --- docs/faq/_category_.json | 4 ---- docs/faq/faq.md | 7 ------- docs/reference/js-client.md | 8 ++++++++ 3 files changed, 8 insertions(+), 11 deletions(-) delete mode 100644 docs/faq/_category_.json delete mode 100644 docs/faq/faq.md diff --git a/docs/faq/_category_.json b/docs/faq/_category_.json deleted file mode 100644 index 98ca18ea..00000000 --- a/docs/faq/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "FAQ", - "position": 8 -} \ No newline at end of file diff --git a/docs/faq/faq.md b/docs/faq/faq.md deleted file mode 100644 index 0a3d2e6f..00000000 --- a/docs/faq/faq.md +++ /dev/null @@ -1,7 +0,0 @@ -# Frequently Asked Questions (FAQ) - -## Why Can I Not Send Notifications from a Front-end SDK? - -NotificationAPI front-end SDKs require your `clientId` and `clientSecret` keys that are unique to your account. If anyone else obtained your keys then they would be able to edit or delete your notifications, and be able to send requests to NotificationAPI from your account. This is a security risk to you and your clients. - -To better protect you, the NotificationAPI front-end SDKs do not allow _sending_ notifications: they only allow _receiving_ notifications. If you require sending notifications from your front-end, it is recommended to use a NotificationAPI back-end SDK on your back-end and expose an API for your front-end. \ No newline at end of file diff --git a/docs/reference/js-client.md b/docs/reference/js-client.md index c44cd597..ae24badd 100644 --- a/docs/reference/js-client.md +++ b/docs/reference/js-client.md @@ -374,3 +374,11 @@ notificationapi.showUserPreferences(); | id\* | string | The unique ID of the user in your system. | | email | string | The email of the user. | | phone | string | The phone number of the user. Expected format: +15554443333. | + +## Frequently Asked Questions (FAQ) + +### Why Can I Not Send Notifications from a Front-end SDK? + +NotificationAPI back-end SDKs require your `clientId` and `clientSecret` keys that are unique to your account. If anyone else obtained your keys then they would be able to edit or delete your notifications, and be able to send requests to NotificationAPI from your account. This is a security risk to you and your clients. + +To better protect you, the NotificationAPI front-end SDKs do not allow _sending_ notifications: they only allow _receiving_ notifications. If you require sending notifications from your front-end, it is recommended to use a NotificationAPI back-end SDK on your back-end and expose an API for your front-end. \ No newline at end of file