Skip to main content

Documentation Index

Fetch the complete documentation index at: https://cometchat-22654f5b-docs-campaigns-service-rest-api.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

The Notification Settings page lets you manage push notification provider credentials for your app. You must configure at least one provider to deliver push notifications through campaigns.

Push Notifications

A global toggle at the top of the page enables or disables push notifications for the entire app.

Providers

Firebase Cloud Messaging (FCM)

FieldTypeDescription
providerIdstringUnique name/identifier for this credential
serviceAccountFilenamestringName of the uploaded JSON file
serviceAccountCredsobjectService account JSON contents (project_id, client_email, private_key, private_key_id)
notificationInPayloadobjectPer-platform toggle for chat/call notifications
The notificationInPayload field controls whether notifications are included in the payload per platform:
{
  "ios": { "chat": true, "call": true },
  "android": { "chat": true, "call": true },
  "web": { "chat": true, "call": false }
}

Apple Push Notification service (APNs)

FieldTypeDescription
providerIdstringUnique name/identifier for this credential
productionModebooleantrue for production, false for development/sandbox
teamIdstringApple Team ID
bundleIdstringApp Bundle ID
keyIdstringAPNs Key ID
p8KeyFilenamestringUploaded .p8 key filename
p8KeystringThe .p8 key content
includeContentAvailablebooleanInclude content-available flag in push payload
includeMutableContentbooleanInclude mutable-content flag in push payload

Custom Push Notification Provider

FieldTypeDescription
webhookURLstringYour webhook endpoint URL
isEnabledbooleanEnable/disable the custom provider
useBasicAuthbooleanEnable Basic Authentication
basicAuthUsernamestringUsername (required if useBasicAuth is true)
basicAuthPasswordstringPassword (required if useBasicAuth is true)

Multiple Credentials

  • FCM — Multiple credentials supported. Set one as default (star icon).
  • APNs — Multiple credentials supported. Set one as default (star icon).
  • Custom — Limited to a single instance.

Validation

Credentials are saved without a test connection. Validation happens at delivery time — if credentials are invalid, push notifications will fail with an error in the campaign delivery report.
There is no auto-verify or test connection feature. Ensure your credentials are correct before sending campaigns.