Create subscriber

Creates a subscriber entity, in the Novu platform. The subscriber will be later used to receive notifications, and access notification feeds. Communication credentials such as email, phone number, and 3 rd party credentials i.e slack tokens could be later associated to this entity.

cURL

curl --location 'https://api.novu.co/v1/subscribers' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'Authorization: ApiKey <NOVU_API_KEY>' \
  --data-raw '{
    "firstName": "Pawan",
    "lastName": "Jain",
    "email": "[e-mail]",
    "phone": "[phone]",
    "avatar": "avatar-url",
    "locale": "en-US",
    "data": {
      "isDeveloper": true,
      "customKey": "customValue"
      }
    }'

Response

{
    "data": {
        "_organizationId": "abcd12349876wxyz1234wxyz",
        "_environmentId": "zyxw4321abcd1234lmno5678",
        "firstName": "Alex",
        "lastName": "Benjamin",
        "phone": "123456789",
        "subscriberId": "abcd1234",
        "email": "[e-mail]",
        "avatar": "string",
        "locale": "en-US",
        "channels": [],
        "_id": "6516ed5a9d727fe8256028ed",
        "deleted": false,
        "createdAt": "2023-09-29T15:29:30.667Z",
        "updatedAt": "2023-09-29T15:29:30.667Z",
        "__v": 0,
        "id": "6516ed5a9d727fe8256028ed"
    }
}

Body

application/json

subscriberId

string

required

The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems

email

string

firstName

string

lastName

string

phone

string

avatar

string

An http url to the profile image of your subscriber

locale

string

data

object

Response

201 - application/json

data

object

Show child attributes

data._id

string

The internal id novu generated for your subscriber, this is not the subscriberId matching your query. See subscriberId for that

data.firstName

string

data.lastName

string

data.email

string

data.phone

string

data.avatar

string

data.locale

string

data.subscriberId

string

required

The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems

data.channels

object[]

Channels settings for subscriber

Show child attributes

data.channels.providerId

enum<string>

required

The provider identifier for the credentials

Available options:

slack,

discord,

msteams,

mattermost,

ryver,

zulip,

grafana-on-call,

getstream,

rocket-chat,

fcm,

apns,

expo,

one-signal,

pushpad,

push-webhook,

pusher-beams

data.channels.integrationIdentifier

string

The integration identifier

data.channels.credentials

object

required

Credentials payload for the specified provider

Show child attributes

data.channels.credentials.webhookUrl

string

required

Webhook url used by chat app integrations. The webhook should be obtained from the chat app provider.

data.channels.credentials.channel

string

Channel specification for Mattermost chat notifications

data.channels.credentials.deviceTokens

string[]

Contains an array of the subscriber device tokens for a given provider. Used on Push integrations

data.channels.credentials.alertUid

string

alert_uid for grafana on-call webhook payload

data.channels.credentials.title

string

title to be used with grafana on call webhook

data.channels.credentials.imageUrl

string

image_url property fo grafana on call webhook

data.channels.credentials.state

string

state property fo grafana on call webhook

data.channels.credentials.externalUrl

string

link_to_upstream_details property fo grafana on call webhook

data.channels._integrationId

string

required

Id of the integration that is used for this channel

data.isOnline

boolean

data.lastOnlineAt

string

data._organizationId

string

required

data._environmentId

string

required

data.deleted

boolean

required

data.createdAt

string

required

data.updatedAt

string

required

data.__v

number