ProviderInfo
Configured notification provider and its integration identifier and active state.
Usage profiles
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
provider | string (PROVIDER_TYPE_FCM, PROVIDER_TYPE_APNS, PROVIDER_TYPE_SENDGRID, PROVIDER_TYPE_SES, PROVIDER_TYPE_TWILIO, PROVIDER_TYPE_SLACK, PROVIDER_TYPE_DISCORD) or integer (int32) | Optional | Notification delivery provider being configured or reported. |
integrationId | string | Optional | Identifier of the provider integration in Novu. |
active | boolean | Optional | Whether the resource is marked active. |
Values of provider
Service used to deliver a notification through its selected channel.
| Value | No. | Form | Meaning |
|---|---|---|---|
PROVIDER_TYPE_FCM | 1 | Canonical | Firebase Cloud Messaging for device or web push delivery. |
PROVIDER_TYPE_APNS | 2 | Canonical | Apple Push Notification service for Apple-device push delivery. |
PROVIDER_TYPE_SENDGRID | 3 | Canonical | SendGrid for email delivery. |
PROVIDER_TYPE_SES | 4 | Canonical | Amazon Simple Email Service for email delivery. |
PROVIDER_TYPE_TWILIO | 5 | Canonical | Twilio for SMS delivery. |
PROVIDER_TYPE_SLACK | 6 | Canonical | Slack for chat-message delivery. |
PROVIDER_TYPE_DISCORD | 7 | Canonical | Discord for chat-message delivery. |
Where used
| Reference | Relationship |
|---|---|
| List configured providers | POST /api/v1/notifications/manage/get-providers |
Download the public reference contract.
Document: DOC-API-MODEL-provider-info.