Save Custom Provider for Push Notifications
curl --request POST \
--url https://{appid}.api-{region}.cometchat.io/v3/notifications/push/v1/providers/custom \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"isEnabled": true,
"webhookURL": "<string>",
"useBasicAuth": true,
"basicAuthUsername": "<string>",
"basicAuthPassword": "<string>"
}
'import requests
url = "https://{appid}.api-{region}.cometchat.io/v3/notifications/push/v1/providers/custom"
payload = {
"isEnabled": 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,
webhookURL: '<string>',
useBasicAuth: true,
basicAuthUsername: '<string>',
basicAuthPassword: '<string>'
})
};
fetch('https://{appid}.api-{region}.cometchat.io/v3/notifications/push/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/push/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,
'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/push/v1/providers/custom"
payload := strings.NewReader("{\n \"isEnabled\": 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/push/v1/providers/custom")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"isEnabled\": 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/push/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 \"webhookURL\": \"<string>\",\n \"useBasicAuth\": true,\n \"basicAuthUsername\": \"<string>\",\n \"basicAuthPassword\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"pushProviders": [
{
"basicAuthUsername": "user123",
"basicAuthPassword": "pass123",
"useBasicAuth": true,
"isEnabled": true,
"webhookURL": "https://trigger-push.example.com/cometchat"
}
]
}
}Notifications
Save Custom Provider for Push Notifications
Saves the custom provider for Push Notifications for a given app.
POST
/
notifications
/
push
/
v1
/
providers
/
custom
Save Custom Provider for Push Notifications
curl --request POST \
--url https://{appid}.api-{region}.cometchat.io/v3/notifications/push/v1/providers/custom \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"isEnabled": true,
"webhookURL": "<string>",
"useBasicAuth": true,
"basicAuthUsername": "<string>",
"basicAuthPassword": "<string>"
}
'import requests
url = "https://{appid}.api-{region}.cometchat.io/v3/notifications/push/v1/providers/custom"
payload = {
"isEnabled": 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,
webhookURL: '<string>',
useBasicAuth: true,
basicAuthUsername: '<string>',
basicAuthPassword: '<string>'
})
};
fetch('https://{appid}.api-{region}.cometchat.io/v3/notifications/push/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/push/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,
'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/push/v1/providers/custom"
payload := strings.NewReader("{\n \"isEnabled\": 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/push/v1/providers/custom")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"isEnabled\": 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/push/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 \"webhookURL\": \"<string>\",\n \"useBasicAuth\": true,\n \"basicAuthUsername\": \"<string>\",\n \"basicAuthPassword\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"pushProviders": [
{
"basicAuthUsername": "user123",
"basicAuthPassword": "pass123",
"useBasicAuth": true,
"isEnabled": true,
"webhookURL": "https://trigger-push.example.com/cometchat"
}
]
}
}Authorizations
API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).
Body
application/json
Use custom provider
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 push notification's custom provider
The response is of type object.
⌘I