Update subscriber credentials

PUT

subscribers

{subscriberId}

credentials

curl --request PUT \
  --url https://api.novu.co/v1/subscribers/{subscriberId}/credentials \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "providerId": "slack",
  "integrationIdentifier": "<string>",
  "credentials": {
    "webhookUrl": "https://example.com/webhook",
    "channel": "general",
    "deviceTokens": [
      "token1",
      "token2",
      "token3"
    ],
    "alertUid": "12345-abcde",
    "title": "Critical Alert",
    "imageUrl": "https://example.com/image.png",
    "state": "resolved",
    "externalUrl": "https://example.com/details"
  }
}'

{
  "data": {
    "_id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "avatar": "<string>",
    "locale": "<string>",
    "subscriberId": "<string>",
    "channels": [
      {
        "providerId": "slack",
        "integrationIdentifier": "<string>",
        "credentials": {
          "webhookUrl": "https://example.com/webhook",
          "channel": "general",
          "deviceTokens": [
            "token1",
            "token2",
            "token3"
          ],
          "alertUid": "12345-abcde",
          "title": "Critical Alert",
          "imageUrl": "https://example.com/image.png",
          "state": "resolved",
          "externalUrl": "https://example.com/details"
        },
        "_integrationId": "<string>"
      }
    ],
    "topics": [
      "<string>"
    ],
    "isOnline": true,
    "lastOnlineAt": "<string>",
    "_organizationId": "<string>",
    "_environmentId": "<string>",
    "deleted": true,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "__v": 123,
    "data": {},
    "timezone": "<string>"
  }
}

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

credentials.webhookUrl

string

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

Example:

"https://example.com/webhook"

credentials.channel

string

Channel specification for Mattermost chat notifications.

Example:

"general"

credentials.deviceTokens

string[]

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

Example:

["token1", "token2", "token3"]

credentials.alertUid

string

Alert UID for Grafana on-call webhook payload.

Example:

"12345-abcde"

credentials.title

string

Title to be used with Grafana on-call webhook.

Example:

"Critical Alert"

credentials.imageUrl

string

Image URL property for Grafana on-call webhook.

Example:

"https://example.com/image.png"

credentials.state

string

State property for Grafana on-call webhook.

Example:

"resolved"

credentials.externalUrl

string

Link to upstream details property for Grafana on-call webhook.

Example:

"https://example.com/details"

integrationIdentifier

string

The integration identifier

Response

200

application/json

data

object

data.subscriberId

string

required

The identifier used to create this subscriber, which typically corresponds to the user ID in your system.

data._organizationId

string

required

The unique identifier of the organization to which the subscriber belongs.

data._environmentId

string

required

The unique identifier of the environment associated with this subscriber.

data.deleted

boolean

required

Indicates whether the subscriber has been deleted.

data.createdAt

string

required

The timestamp indicating when the subscriber was created, in ISO 8601 format.

data.updatedAt

string

required

The timestamp indicating when the subscriber was last updated, in ISO 8601 format.

data._id

string

The internal ID generated by Novu for your subscriber. This ID does not match the subscriberId used in your queries. Refer to subscriberId for that identifier.

data.firstName

string

The first name of the subscriber.

data.lastName

string

The last name of the subscriber.

data.email

string | null

The email address of the subscriber.

data.phone

string

The phone number of the subscriber.

data.avatar

string

The URL of the subscriber's avatar image.

data.locale

string

The locale setting of the subscriber, indicating their preferred language or region.

data.channels

object[]

An array of channel settings associated with the subscriber.

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,

whatsapp-business,

fcm,

apns,

expo,

one-signal,

pushpad,

push-webhook,

pusher-beams

data.channels.credentials

object

required

Credentials payload for the specified provider

data.channels.credentials.webhookUrl

string

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

Example:

"https://example.com/webhook"

data.channels.credentials.channel

string

Channel specification for Mattermost chat notifications.

Example:

"general"

data.channels.credentials.deviceTokens

string[]

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

Example:

["token1", "token2", "token3"]

data.channels.credentials.alertUid

string

Alert UID for Grafana on-call webhook payload.

Example:

"12345-abcde"

data.channels.credentials.title

string

Title to be used with Grafana on-call webhook.

Example:

"Critical Alert"

data.channels.credentials.imageUrl

string

Image URL property for Grafana on-call webhook.

Example:

"https://example.com/image.png"

data.channels.credentials.state

string

State property for Grafana on-call webhook.

Example:

"resolved"

data.channels.credentials.externalUrl

string

Link to upstream details property for Grafana on-call webhook.

Example:

"https://example.com/details"

data.channels._integrationId

string

required

The unique identifier of the integration associated with this channel.

data.channels.integrationIdentifier

string

The integration identifier

data.topics

string[]

deprecated

An array of topics that the subscriber is subscribed to.

data.isOnline

boolean

Indicates whether the subscriber is currently online.

data.lastOnlineAt

string

The timestamp indicating when the subscriber was last online, in ISO 8601 format.

data.__v

number

The version of the subscriber document.

data.data

object | null

Additional custom data for the subscriber

data.timezone

string

Timezone of the subscriber

Was this page helpful?

Delete subscriber Delete subscriber credentials by providerId

curl --request PUT \
  --url https://api.novu.co/v1/subscribers/{subscriberId}/credentials \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "providerId": "slack",
  "integrationIdentifier": "<string>",
  "credentials": {
    "webhookUrl": "https://example.com/webhook",
    "channel": "general",
    "deviceTokens": [
      "token1",
      "token2",
      "token3"
    ],
    "alertUid": "12345-abcde",
    "title": "Critical Alert",
    "imageUrl": "https://example.com/image.png",
    "state": "resolved",
    "externalUrl": "https://example.com/details"
  }
}'

{
  "data": {
    "_id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "avatar": "<string>",
    "locale": "<string>",
    "subscriberId": "<string>",
    "channels": [
      {
        "providerId": "slack",
        "integrationIdentifier": "<string>",
        "credentials": {
          "webhookUrl": "https://example.com/webhook",
          "channel": "general",
          "deviceTokens": [
            "token1",
            "token2",
            "token3"
          ],
          "alertUid": "12345-abcde",
          "title": "Critical Alert",
          "imageUrl": "https://example.com/image.png",
          "state": "resolved",
          "externalUrl": "https://example.com/details"
        },
        "_integrationId": "<string>"
      }
    ],
    "topics": [
      "<string>"
    ],
    "isOnline": true,
    "lastOnlineAt": "<string>",
    "_organizationId": "<string>",
    "_environmentId": "<string>",
    "deleted": true,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "__v": 123,
    "data": {},
    "timezone": "<string>"
  }
}

API Reference

Events

Subscribers

Topics

Notification

Workflows

Workflow Overrides

Workflow groups

Integrations

Layouts

Inbound Parse

Environments

Changes

Execution Details

Feeds

Tenants

Organizations

Messages

Blueprints

Update subscriber credentials

Authorizations

Path Parameters

Body

Response