Sign in
Channel Endpoints

List all channel endpoints

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

get/v1/channel-endpoints

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

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

The subscriber ID to filter results by

contextKeysstring[]

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

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' | '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' | 'msteams' | 'webex-messaging' | 'mattermost' | 'ryver' | 'zulip' | 'grafana-on-call' | 'getstream' | 'rocket-chat' | 'whatsapp-business' | 'line' | 'chat-webhook' | 'novu-slack' | 'telegram' | 'sendblue' | 'novu-web-chat' | 'anthropic' | 'novu-anthropic' | 'anthropic-aws' | 'pagerduty' | 'opsgenie' | 'grafana' | 'tool-webhook'

Provider ID of the job

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

integrationIdentifierstring

Integration identifier to filter results.

connectionIdentifierstring

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

Changed in 5 of the 12 revisions of this API.42015

  • 24e82408dec7112See the full diff
    • ▲

      removed the enum value novu-agent-chat from the query request parameter providerId

      request-parameter-enum-value-removed

    • ●

      added the new novu-web-chat enum value to the data/items/providerId response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new enum value novu-web-chat to the query request parameter providerId

      request-parameter-enum-value-added

    • ○

      removed the novu-agent-chat enum value from the data/items/providerId response property for the response status 200

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c2b2fa0d5d48112See the full diff
    • ▲

      removed the enum value novu-web-chat from the query request parameter providerId

      request-parameter-enum-value-removed

    • ●

      added the new novu-agent-chat enum value to the data/items/providerId response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new enum value novu-agent-chat to the query request parameter providerId

      request-parameter-enum-value-added

    • ○

      removed the novu-web-chat enum value from the data/items/providerId response property for the response status 200

      response-property-enum-value-removed

  • 8092e41edd57142See the full diff
    • ▲

      added GrafanaOnCallIntegrationEndpointDto ToolWebhookEndpointDto to the data/items/endpoint response property oneOf list for the response status 200

      response-property-one-of-added

    • ●

      added the new grafana enum value to the data/items/providerId response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new grafana_oncall_integration enum value to the data/items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new novu-web-chat enum value to the data/items/providerId response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new tool_webhook enum value to the data/items/type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new enum value grafana to the query request parameter providerId

      request-parameter-enum-value-added

    • ○

      added the new enum value novu-web-chat to the query request parameter providerId

      request-parameter-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ab1c5d528f9711See the full diff
    • ●

      added the new ruach-sms enum value to the data/items/providerId response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new enum value ruach-sms to the query request parameter providerId

      request-parameter-enum-value-added

  • c69777f601841138See the full diff
    • ▲

      added WebexRoomEndpointDto WebexPersonEndpointDto LineUserEndpointDto PagerDutyServiceEndpointDto OpsgenieIntegrationEndpointDto to the data/items/endpoint response property oneOf list for the response status 200

      response-property-one-of-added

    • ●

      added the new anypost enum value to the data/items/providerId response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new line enum value to the data/items/providerId response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new line_user enum value to the data/items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new opsgenie enum value to the data/items/providerId response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new opsgenie_integration enum value to the data/items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new pagerduty enum value to the data/items/providerId response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new pagerduty_service enum value to the data/items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new sendblue enum value to the data/items/providerId response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new tool enum value to the data/items/channel response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new tool-webhook enum value to the data/items/providerId response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new webex-messaging enum value to the data/items/providerId response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new webex_person enum value to the data/items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new webex_room enum value to the data/items/type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new enum value anypost to the query request parameter providerId

      request-parameter-enum-value-added

    • ○

      added the new enum value line to the query request parameter providerId

      request-parameter-enum-value-added

    • ○

      added the new enum value opsgenie to the query request parameter providerId

      request-parameter-enum-value-added

    • ○

      added the new enum value pagerduty to the query request parameter providerId

      request-parameter-enum-value-added

    • ○

      added the new enum value sendblue to the query request parameter providerId

      request-parameter-enum-value-added

    • ○

      added the new enum value tool to the query request parameter channel

      request-parameter-enum-value-added

    • ○

      added the new enum value tool-webhook to the query request parameter providerId

      request-parameter-enum-value-added

    • ○

      added the new enum value webex-messaging to the query request parameter providerId

      request-parameter-enum-value-added