Skip to main content
POST
/
notifications
/
sms
/
v1
/
providers
/
custom
Save Custom Provider for SMS Notifications
curl --request POST \
  --url https://{appid}.api-{region}.cometchat.io/v3/notifications/sms/v1/providers/custom \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "useStoredPhNo": false,
  "isEnabled": true,
  "webhookURL": "<string>",
  "useBasicAuth": true,
  "basicAuthUsername": "<string>",
  "basicAuthPassword": "<string>"
}
'
{
  "data": {
    "basicAuthUsername": "user889",
    "basicAuthPassword": "pass122",
    "isEnabled": true,
    "useBasicAuth": true,
    "useStoredPhNo": false,
    "webhookURL": "https://trigger-sms.example.com/cometchat"
  }
}

Authorizations

​
apikey
string
header
required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Body

application/json
​
useStoredPhNo
boolean
default:false
required

If enabled, the webhook will be triggered for a user only if their phone number is stored within CometChat.

​
isEnabled
boolean
required

Use custom provider

​
webhookURL
string
required

The webhook URL triggered for respective events

​
useBasicAuth
boolean
required

To enable basic auth for the URL

​
basicAuthUsername
string
required

The username for Basic auth

​
basicAuthPassword
string
required

The password for Basic auth

Response

200 - application/json

Save the push notification's SMS custom provider

The response is of type object.