Skip to main content
PUT
/
v1
/
subscribers
/
{subscriberId}
/
credentials
SubscribersController_updateSubscriberChannel
import { Novu } from "@novu/api";
import { UpdateSubscriberChannelRequestDtoProviderId } from "@novu/api/models/components";

const novu = new Novu({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await novu.subscribers.credentials.update("<value>", {
    providerId: UpdateSubscriberChannelRequestDtoProviderId.Pushpad,
    credentials: {
      webhookUrl: "<value>",
    },
  });

  // Handle the result
  console.log(result)
}

run();
{
  "_id": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "avatar": "<string>",
  "locale": "<string>",
  "subscriberId": "<string>",
  "channels": [
    {
      "providerId": "slack",
      "integrationIdentifier": "<string>",
      "credentials": {
        "webhookUrl": "<string>",
        "channel": "<string>",
        "deviceTokens": [
          "<string>"
        ],
        "alertUid": "<string>",
        "title": "<string>",
        "imageUrl": "<string>",
        "state": "<string>",
        "externalUrl": "<string>"
      },
      "_integrationId": "<string>"
    }
  ],
  "isOnline": true,
  "lastOnlineAt": "<string>",
  "_organizationId": "<string>",
  "_environmentId": "<string>",
  "deleted": true,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "__v": 123
}
Enter your API key in the Authorization field like the example shown below:E.g ApiKey 18d2e625f05d80e

Authorizations

​
Authorization
string
header
required

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

Path Parameters

​
subscriberId
string
required

Body

application/json
​
providerId
enum<string>
required

The provider identifier for the credentials

Available options:
slack,
discord,
msteams,
mattermost,
ryver,
zulip,
grafana-on-call,
getstream,
rocket-chat,
whatsapp-business,
fcm,
apns,
expo,
one-signal,
pushpad,
push-webhook,
pusher-beams
​
credentials
object
required

Credentials payload for the specified provider

​
integrationIdentifier
string

The integration identifier

Response

Ok

​
subscriberId
string
required

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

​
_organizationId
string
required
​
_environmentId
string
required
​
deleted
boolean
required
​
createdAt
string
required
​
updatedAt
string
required
​
_id
string

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

​
firstName
string
​
lastName
string
​
email
string
​
phone
string
​
avatar
string
​
locale
string
​
channels
object[]

Channels settings for subscriber

​
isOnline
boolean
​
lastOnlineAt
string
​
__v
number
⌘I