NOnovu
Channel Endpoints

List all channel endpoints

Changed on

List all channel endpoints for a resource based on query filters.

get/v1/channel-endpoints

Request

  • Base URL
    https://api.novu.co
  • Auth
    • API key in header Authorization
    • or API key in header Authorization

Query parameters

afterstring

Cursor for pagination indicating the starting point after which to fetch results.

beforestring

Cursor for pagination indicating the ending point before which to fetch results.

limitnumber
Example:10

Limit the number of items to return (max 100)

orderDirection'ASC' | 'DESC'

Direction of sorting

orderBystring

Field to order by

includeCursorboolean

Include cursor item in response

subscriberIdstring
Example:subscriber-123

The subscriber ID to filter results by

contextKeysstring[]

Filter by exact context keys, order insensitive (format: "type:id")

[
  "tenant:org-123",
  "region:us-east-1"
]
channel'in_app' | 'email' | 'sms' | 'chat' | 'push' | 'tool'

Channel type to filter results.

providerId'anypost' | 'emailjs' | 'mailgun' | 'mailjet' | 'mandrill' | 'nodemailer' | 'postmark' | 'sendgrid' | 'sendinblue' | 'ses' | 'netcore' | 'infobip-email' | 'resend' | 'plunk' | 'mailersend' | 'mailtrap' | 'clickatell' | 'outlook365' | 'novu-email' | 'sparkpost' | 'email-webhook' | 'braze' | 'novu-email-agent' | 'agent-email-inbox' | 'nexmo' | 'plivo' | 'sms77' | 'sms-central' | 'sns' | 'telnyx' | 'twilio' | 'gupshup' | 'firetext' | 'infobip-sms' | 'burst-sms' | 'bulk-sms' | 'isend-sms' | 'forty-six-elks' | 'kannel' | 'maqsam' | 'termii' | 'africas-talking' | 'novu-sms' | 'sendchamp' | 'generic-sms' | 'clicksend' | 'bandwidth' | 'messagebird' | 'simpletexting' | 'azure-sms' | 'ring-central' | 'brevo-sms' | 'eazy-sms' | 'mobishastra' | 'afro-message' | 'unifonic' | 'smsmode' | 'imedia' | 'sinch' | 'isendpro-sms' | 'cm-telecom' | 'ruach-sms' | 'fcm' | 'apns' | 'expo' | 'one-signal' | 'pushpad' | 'push-webhook' | 'pusher-beams' | 'appio' | 'novu' | 'slack' | 'discord' | 'google-chat' | 'msteams' | 'webex-messaging' | 'mattermost' | 'ryver' | 'zulip' | 'grafana-on-call' | 'getstream' | 'rocket-chat' | 'whatsapp-business' | 'line' | 'chat-webhook' | 'novu-slack' | 'telegram' | 'sendblue' | 'photon-imessage' | 'novu-web-chat' | 'anthropic' | 'novu-anthropic' | 'anthropic-aws' | 'pagerduty' | 'opsgenie' | 'grafana' | 'tool-webhook'

Provider ID of the execution

Filter by provider identifier (e.g., sendgrid, twilio, slack, etc.).

integrationIdentifierstring
Example:slack-prod

Integration identifier to filter results.

connectionIdentifierstring
Example:slack-connection-abc123

Connection identifier to filter results.

Headers

idempotency-keystring

A header for idempotency purposes

Response

OK

nextstring nullable required

The cursor for the next page of results, or null if there are no more pages.

previousstring nullable required

The cursor for the previous page of results, or null if this is the first page.

totalCountnumber required

The total count of items (up to 50,000)

totalCountCappedboolean required

Whether there are more than 50,000 results available

Example response

{
  "data": [
    {
      "providerId": "slack",
      "integrationIdentifier": "slack-prod",
      "connectionIdentifier": "slack-connection-abc123",
      "subscriberId": "subscriber-123",
      "contextKeys": [
        "tenant:org-123",
        "region:us-east-1"
      ],
      "type": "slack_channel",
      "endpoint": {
        "channelId": "C123456789"
      }
    }
  ]
}

Changes

  • a5b639d63138Revision changes
    • info

      the /////// response's property pattern was changed from /^[a-zA-Z0-9]{32}$/ to ^[a-zA-Z0-9]{32}$ for the status

    • info

      the /////// response's property pattern GRAFANA_ONCALL_WEBHOOK_URL_PATTERN was removed for the status

    • info

      the /////// response's property pattern OPSGENIE_API_KEY_PATTERN was removed for the status

  • 951a80501fceRevision changes
    • warning

      added the new agent-email-inbox enum value to the // response property for the response status

    • info

      added the new enum value agent-email-inbox to the query request parameter providerId