Subscribers

Update provider credentials

Update credentials for a provider such as slack and FCM. providerId is required field. This API creates the deviceTokens or replaces the existing ones.

put/v1/subscribers/{subscriberId}/credentials

Request

  • Base URL: https://api.notifly.io
  • URL: https://api.notifly.io/v1/subscribers/{subscriberId}/credentials
  • Auth: API key in header Authorization

Path parameters

subscriberIdstring required

Request body

providerId'slack' | 'discord' | 'msteams' | 'webex-messaging' | 'mattermost' | 'ryver' | 'zulip' | 'grafana-on-call' | 'getstream' | 'rocket-chat' | 'whatsapp-business' | 'line' | 'chat-webhook' | 'novu-slack' | 'telegram' | 'sendblue' | 'novu-web-chat' | 'fcm' | 'apns' | 'expo' | 'one-signal' | 'pushpad' | 'push-webhook' | 'pusher-beams' | 'appio' | 'web-push' required

The provider identifier for the credentials

integrationIdentifierstring

The integration identifier

Example request

{
  "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"
  }
}

Response

OK

Example response

{
  "data": {
    "channels": [
      {
        "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"
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.