Save Custom Provider for Email Notifications
curl --request POST \
--url https://{appId}.api-{region}.cometchat.io/v3/notifications/email/v1/providers/custom \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"isEnabled": true,
"useStoredEmailID": true,
"webhookURL": "<string>",
"useBasicAuth": true,
"basicAuthUsername": "<string>",
"basicAuthPassword": "<string>"
}
'import requests
url = "https://{appId}.api-{region}.cometchat.io/v3/notifications/email/v1/providers/custom"
payload = {
"isEnabled": True,
"useStoredEmailID": True,
"webhookURL": "<string>",
"useBasicAuth": True,
"basicAuthUsername": "<string>",
"basicAuthPassword": "<string>"
}
headers = {
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
isEnabled: true,
useStoredEmailID: true,
webhookURL: '<string>',
useBasicAuth: true,
basicAuthUsername: '<string>',
basicAuthPassword: '<string>'
})
};
fetch('https://{appId}.api-{region}.cometchat.io/v3/notifications/email/v1/providers/custom', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{appId}.api-{region}.cometchat.io/v3/notifications/email/v1/providers/custom",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'isEnabled' => true,
'useStoredEmailID' => true,
'webhookURL' => '<string>',
'useBasicAuth' => true,
'basicAuthUsername' => '<string>',
'basicAuthPassword' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apikey: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{appId}.api-{region}.cometchat.io/v3/notifications/email/v1/providers/custom"
payload := strings.NewReader("{\n \"isEnabled\": true,\n \"useStoredEmailID\": true,\n \"webhookURL\": \"<string>\",\n \"useBasicAuth\": true,\n \"basicAuthUsername\": \"<string>\",\n \"basicAuthPassword\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("apikey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{appId}.api-{region}.cometchat.io/v3/notifications/email/v1/providers/custom")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"isEnabled\": true,\n \"useStoredEmailID\": true,\n \"webhookURL\": \"<string>\",\n \"useBasicAuth\": true,\n \"basicAuthUsername\": \"<string>\",\n \"basicAuthPassword\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{appId}.api-{region}.cometchat.io/v3/notifications/email/v1/providers/custom")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"isEnabled\": true,\n \"useStoredEmailID\": true,\n \"webhookURL\": \"<string>\",\n \"useBasicAuth\": true,\n \"basicAuthUsername\": \"<string>\",\n \"basicAuthPassword\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"basicAuthUsername": "user889",
"basicAuthPassword": "pass122",
"isEnabled": true,
"useBasicAuth": true,
"useStoredEmailID": false,
"webhookURL": "https://trigger-email.example.com/cometchat"
}
}Custom Provider
Save Custom Provider for Email Notifications
Saves the custom provider for Email Notifications for a given app.
POST
/
notifications
/
email
/
v1
/
providers
/
custom
Save Custom Provider for Email Notifications
curl --request POST \
--url https://{appId}.api-{region}.cometchat.io/v3/notifications/email/v1/providers/custom \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"isEnabled": true,
"useStoredEmailID": true,
"webhookURL": "<string>",
"useBasicAuth": true,
"basicAuthUsername": "<string>",
"basicAuthPassword": "<string>"
}
'import requests
url = "https://{appId}.api-{region}.cometchat.io/v3/notifications/email/v1/providers/custom"
payload = {
"isEnabled": True,
"useStoredEmailID": True,
"webhookURL": "<string>",
"useBasicAuth": True,
"basicAuthUsername": "<string>",
"basicAuthPassword": "<string>"
}
headers = {
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
isEnabled: true,
useStoredEmailID: true,
webhookURL: '<string>',
useBasicAuth: true,
basicAuthUsername: '<string>',
basicAuthPassword: '<string>'
})
};
fetch('https://{appId}.api-{region}.cometchat.io/v3/notifications/email/v1/providers/custom', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{appId}.api-{region}.cometchat.io/v3/notifications/email/v1/providers/custom",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'isEnabled' => true,
'useStoredEmailID' => true,
'webhookURL' => '<string>',
'useBasicAuth' => true,
'basicAuthUsername' => '<string>',
'basicAuthPassword' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apikey: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{appId}.api-{region}.cometchat.io/v3/notifications/email/v1/providers/custom"
payload := strings.NewReader("{\n \"isEnabled\": true,\n \"useStoredEmailID\": true,\n \"webhookURL\": \"<string>\",\n \"useBasicAuth\": true,\n \"basicAuthUsername\": \"<string>\",\n \"basicAuthPassword\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("apikey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{appId}.api-{region}.cometchat.io/v3/notifications/email/v1/providers/custom")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"isEnabled\": true,\n \"useStoredEmailID\": true,\n \"webhookURL\": \"<string>\",\n \"useBasicAuth\": true,\n \"basicAuthUsername\": \"<string>\",\n \"basicAuthPassword\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{appId}.api-{region}.cometchat.io/v3/notifications/email/v1/providers/custom")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"isEnabled\": true,\n \"useStoredEmailID\": true,\n \"webhookURL\": \"<string>\",\n \"useBasicAuth\": true,\n \"basicAuthUsername\": \"<string>\",\n \"basicAuthPassword\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"basicAuthUsername": "user889",
"basicAuthPassword": "pass122",
"isEnabled": true,
"useBasicAuth": true,
"useStoredEmailID": false,
"webhookURL": "https://trigger-email.example.com/cometchat"
}
}For the complete error reference, see Error Guide.
Authorizations
API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).
Body
application/json
Use custom provider
If enabled, the webhook will be triggered for a user only if their email address is stored within CometChat.
The webhook URL to be triggered for the respective events.
To enable basic auth for the URL
The username for Basic auth
The password for Basic auth
Response
200 - application/json
Save the push notification's SMS custom provider
The response is of type object.
Was this page helpful?
Get Custom Provider for Email Notifications
Previous
Update Custom Provider for Email Notifications
Next
⌘I