DOC-API-MODEL-schema-p28bvfiqrb#overview
ProviderInfo
Configured notification provider and its integration identifier and active state.
Meaning and usage
Section ID: DOC-API-MODEL-schema-p28bvfiqrb#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-p28bvfiqrb#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-p28bvfiqrb#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-p28bvfiqrb#field-providerSection ID: DOC-API-MODEL-schema-p28bvfiqrb#response-field-providerprovider | 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; explicit presence | Notification delivery provider being configured or reported. |
Section ID: DOC-API-MODEL-schema-p28bvfiqrb#field-integrationidSection ID: DOC-API-MODEL-schema-p28bvfiqrb#response-field-integrationidintegrationId | string | Optional | Identifier of the provider integration in Novu. |
Section ID: DOC-API-MODEL-schema-p28bvfiqrb#field-activeSection ID: DOC-API-MODEL-schema-p28bvfiqrb#response-field-activeactive | boolean | Optional | Whether the resource is marked active. |
Values of provider
Section ID: DOC-API-MODEL-schema-p28bvfiqrb#response-values-provider
Service used to deliver a notification through its selected channel.
| Value | No. | Form | Meaning |
|---|---|---|---|
PROVIDER_TYPE_FCM | 0 | Canonical | See meaning below. |
PROVIDER_TYPE_APNS | 1 | Canonical | See meaning below. |
PROVIDER_TYPE_SENDGRID | 2 | Canonical | See meaning below. |
PROVIDER_TYPE_SES | 3 | Canonical | See meaning below. |
PROVIDER_TYPE_TWILIO | 4 | Canonical | See meaning below. |
PROVIDER_TYPE_SLACK | 5 | Canonical | See meaning below. |
PROVIDER_TYPE_DISCORD | 6 | Canonical | See meaning below. |
PROVIDER_TYPE_FCM
Firebase Cloud Messaging for device or web push delivery.
Firebase Cloud Messaging (push)
PROVIDER_TYPE_APNS
Apple Push Notification service for Apple-device push delivery.
Apple Push Notification Service
PROVIDER_TYPE_SENDGRID
SendGrid for email delivery.
SendGrid (email)
PROVIDER_TYPE_SES
Amazon Simple Email Service for email delivery.
AWS SES (email)
PROVIDER_TYPE_TWILIO
Twilio for SMS delivery.
Twilio (SMS)
PROVIDER_TYPE_SLACK
Slack for chat-message delivery.
Slack (chat)
PROVIDER_TYPE_DISCORD
Discord for chat-message delivery.
Discord (chat)
Where used
Section ID: DOC-API-MODEL-schema-p28bvfiqrb#where-used
| Reference | Relationship |
|---|---|
| List configured providers | POST /api/v1/notifications/manage/get-providers |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-p28bvfiqrb