Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions notifications/email-custom-providers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
2. Enable the provider.
3. Enter the publicly accessible webhook URL.
4. (Recommended) Enable Basic Authentication and set username/password.
5. Decide if you want to **Trigger only if email address is stored with CometChat** (via [Update Contact details API](/rest-api/chat-apis)); when off, the webhook fires regardless.
5. Decide if you want to **Trigger only if email address is stored with CometChat** (via [Update Contact details API](/rest-api/notifications-apis/push/update-contact-details)); when off, the webhook fires regardless.
6. Save the credentials.

<Frame>
Expand Down Expand Up @@ -52,7 +52,7 @@
"avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-4.webp",
"name": "Susan Marie"
},
"message": "Are we meeting on this weekend?",
"message": "Are we meeting this weekend?",
"messageObject": {CometChat Message Object}, // Present if "Include message object" is enabled. The message object is present for new messages or in case a message was edited
},
{
Expand Down Expand Up @@ -98,7 +98,7 @@
"name": "John Paul"
},
"message": "Hello all! What's up?",
"messageObject": {CometChat Message Object}, // Present if "Include message object" is enabled. The message object is present for new messages or in case a message was edited

Check warning on line 101 in notifications/email-custom-providers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

notifications/email-custom-providers.mdx#L101

Did you really mean 'messageObject'?
},
{
"sender": {
Expand All @@ -107,17 +107,17 @@
"name": "Susan Marie"
},
"message": "This is the place I was thinking about",
"messageObject": {CometChat Message Object}, // Present if "Include message object" is enabled. The message object is present for new messages or in case a message was edited

Check warning on line 110 in notifications/email-custom-providers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

notifications/email-custom-providers.mdx#L110

Did you really mean 'messageObject'?
}
],
"groupDetails": {

Check warning on line 113 in notifications/email-custom-providers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

notifications/email-custom-providers.mdx#L113

Did you really mean 'groupDetails'?
"guid": "cometchat-guid-1",
"name": "Hiking Group",
"icon": "https://assets.cometchat.io/sampleapp/v2/groups/cometchat-guid-1.webp"
},
"subject": "New messages in Hiking Group"
},
"appId": "app123",

Check warning on line 120 in notifications/email-custom-providers.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

notifications/email-custom-providers.mdx#L120

Did you really mean 'appId'?
"region": "us/eu/in",
"webhook": "custom"
}
Expand Down
14 changes: 7 additions & 7 deletions notifications/email-integration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

## SendGrid setup

We have partnered with SendGrid for sending Email Notifications and hence you need to set up an account on [SendGrid](https://www.sendgrid.com/) before you start using the extension.
We have partnered with SendGrid for sending Email Notifications and hence you need to set up an account on [SendGrid](https://www.sendgrid.com/) before you start using this integration.

### 1. Get your SendGrid API key

Expand All @@ -35,7 +35,7 @@
9. Enter the Version name and the value for Subject as `{{subject}}` and hit "Save".
10. You have now successfully created a Template with a version.
11. From the Dynamic Templates listing page, expand your Template and make a note of the **Template ID** for later use.
12. The payload sent by the extension to SendGrid is as follows:
12. The payload sent to SendGrid is as follows:

<Tabs>
<Tab title="For one-on-one conversation">
Expand All @@ -54,7 +54,7 @@
"avatar": "https://assets.cometchat.io/sampleapp/v2/users/cometchat-uid-4.webp",
"name": "Susan Marie"
},
"message": "Are we meeting on this weekend?",
"message": "Are we meeting this weekend?",
"messageObject": {CometChat Message Object}, // Present if "Include message object" is enabled. The message object is present for new messages or in case a message was edited
},
{
Expand Down Expand Up @@ -94,7 +94,7 @@
"name": "John Paul"
},
"message": "Hello all! What's up?",
"messageObject": {CometChat Message Object}, // Present if "Include message object" is enabled. The message object is present for new messages or in case a message was edited

Check warning on line 97 in notifications/email-integration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

notifications/email-integration.mdx#L97

Did you really mean 'messageObject'?
},
{
"sender": {
Expand All @@ -103,10 +103,10 @@
"name": "Susan Marie"
},
"message": "This is the place I was thinking about",
"messageObject": {CometChat Message Object}, // Present if "Include message object" is enabled. The message object is present for new messages or in case a message was edited

Check warning on line 106 in notifications/email-integration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

notifications/email-integration.mdx#L106

Did you really mean 'messageObject'?
}
],
"groupDetails": {

Check warning on line 109 in notifications/email-integration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

notifications/email-integration.mdx#L109

Did you really mean 'groupDetails'?
"guid": "cometchat-guid-1",
"name": "Hiking Group",
"icon": "https://assets.cometchat.io/sampleapp/v2/groups/cometchat-guid-1.webp"
Expand Down Expand Up @@ -359,13 +359,13 @@

An unsubscribe group will allow your users to unsubscribe to only chat email notifications and will allow you to continue to send other emails to that user via SendGrid.

1. In the left pane, go to Suppressions and select Unsubscribe Groups.

Check warning on line 362 in notifications/email-integration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

notifications/email-integration.mdx#L362

Did you really mean 'Suppressions'?
2. Click on **"Create New Group"** and give it a name and proper description.
3. Save your new group and make a note of the **Unsubscribe Group ID** for later use.

### 4. Store contact details

Store each user's contact email/phone with the [Update Contact details API](/rest-api/chat-apis). Use the user's UID in `onBehalfOf` and call the region-specific base URL (`api-us`, `api-eu`, `api-in`).
Store each user's contact email/phone with the [Update Contact details API](/rest-api/notifications-apis/push/update-contact-details). Use the user's UID in `onBehalfOf` and call the region-specific base URL (`api-us`, `api-eu`, `api-in`).

Example request:

Expand Down Expand Up @@ -409,13 +409,13 @@

<Note>

The domain used in Sender's Email needs to be Authenticated. Refer to SendGrid's documentation on [Domain Authentication](https://docs.sendgrid.com/ui/account-and-settings/how-to-set-up-domain-authentication) for more details. Use the complete authenticated domain in the sender's email address. For eg, if your domain is example.com and the authenticated domain is em1235.example.com, then the sender's email address should be [sender@em1235.example.com](mailto:sender@em1235.example.com) and not [sender@example.com](mailto:sender@example.com)
The domain used in Sender's Email needs to be Authenticated. Refer to SendGrid's documentation on [Domain Authentication](https://docs.sendgrid.com/ui/account-and-settings/how-to-set-up-domain-authentication) for more details. Use the complete authenticated domain in the sender's email address. For example, if your domain is example.com and the authenticated domain is em1235.example.com, then the sender's email address should be [sender@em1235.example.com](mailto:sender@em1235.example.com) and not [sender@example.com](mailto:sender@example.com)

</Note>

### 7. Save user timezones

A user's timezone is required to allow them to set a schedule for receiving notifications. In case the timezone is not registered, the default timezone for
A user's timezone is required to allow them to set a schedule for receiving notifications. In case the timezone is not registered, the default timezone for the region is used:

* For US region: EST
* For EU region: GMT
Expand All @@ -431,7 +431,7 @@
2. iOS SDK version 4.0.51 and above
3. Web SDK version 4.0.8 and above
4. React Native SDK version 4.0.10 and above
5. Ionic Cordova SDK version 4.0.8 and above (Deprecated - use JavaScript SDK)

Check warning on line 434 in notifications/email-integration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

notifications/email-integration.mdx#L434

Did you really mean 'Cordova'?
6. Flutter SDK version 4.0.15 and above

</Note>
Expand All @@ -446,14 +446,14 @@

### 9. Configure email replies (optional)

In the SendGrid provider settings, enable the email replies. Optionally, you can set a different sender's email address. Only ensure that the it doesn't contain any "+" symbol in it.
In the SendGrid provider settings, enable the email replies. Optionally, you can set a different sender's email address. Just ensure that it doesn't contain any "+" symbol.

Copy the Replies webhook URL as that will be required for Inbound parse configuration on SendGrid's end. Follow the [SendGrid's Inbound parse webhook](https://www.twilio.com/docs/sendgrid/for-developers/parsing-email/setting-up-the-inbound-parse-webhook) steps.

Before saving the Inbound Host and URL:

1. Uncheck Spam Check checkbox.

Check warning on line 455 in notifications/email-integration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

notifications/email-integration.mdx#L455

Did you really mean 'Uncheck'?
2. Uncheck Send Raw checkbox.

Check warning on line 456 in notifications/email-integration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

notifications/email-integration.mdx#L456

Did you really mean 'Uncheck'?

Once this setup is successful, users will be able to reply to an email notification and send messages in a particular conversation on CometChat. The parsing of the replies is heavily dependent on the Email client used and the content of the reply.

Expand Down