Retrieve a channel endpoint

GET

channel-endpoints

{identifier}

TypeScript

import { Novu } from "@novu/api";

const novu = new Novu({
  secretKey: "YOUR_SECRET_KEY_HERE",
});

async function run() {
  const result = await novu.channelEndpoints.retrieve("<value>");

  console.log(result);
}

run();

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;

$sdk = novu\Novu::builder()
    ->setSecurity(
        'YOUR_SECRET_KEY_HERE'
    )
    ->build();



$response = $sdk->channelEndpoints->retrieve(
    identifier: '<value>'
);

if ($response->getChannelEndpointResponseDto !== null) {
    // handle response
}

package main

import(
	"context"
	"github.com/novuhq/novu-go/v3"
	"log"
	"github.com/novuhq/novu-go/v3/models/components"
)

func main() {
    ctx := context.Background()

    s := v3.New(
        v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
    )

    res, err := s.ChannelEndpoints.Retrieve(ctx, "<value>", nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.GetChannelEndpointResponseDto != nil {
        switch res.GetChannelEndpointResponseDto.Endpoint.Type {
            case components.EndpointTypeSlackChannelEndpointDto:
                // res.GetChannelEndpointResponseDto.Endpoint.SlackChannelEndpointDto is populated
            case components.EndpointTypeSlackUserEndpointDto:
                // res.GetChannelEndpointResponseDto.Endpoint.SlackUserEndpointDto is populated
            case components.EndpointTypeWebhookEndpointDto:
                // res.GetChannelEndpointResponseDto.Endpoint.WebhookEndpointDto is populated
            case components.EndpointTypePhoneEndpointDto:
                // res.GetChannelEndpointResponseDto.Endpoint.PhoneEndpointDto is populated
            case components.EndpointTypeMsTeamsChannelEndpointDto:
                // res.GetChannelEndpointResponseDto.Endpoint.MsTeamsChannelEndpointDto is populated
            case components.EndpointTypeMsTeamsUserEndpointDto:
                // res.GetChannelEndpointResponseDto.Endpoint.MsTeamsUserEndpointDto is populated
            case components.EndpointTypeTelegramChatEndpointDto:
                // res.GetChannelEndpointResponseDto.Endpoint.TelegramChatEndpointDto is populated
        }

    }
}

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.novu.co/v1/channel-endpoints/{identifier}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://api.novu.co/v1/channel-endpoints/{identifier}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "identifier": "<string>",
  "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"
  },
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

{
  "statusCode": 404,
  "timestamp": "2024-12-12T13:00:00Z",
  "path": "/api/v1/resource",
  "message": "xx xx xx ",
  "ctx": {
    "workflowId": "some_wf_id",
    "stepId": "some_wf_id"
  },
  "errorId": "abc123"
}

{
  "statusCode": 404,
  "timestamp": "2024-12-12T13:00:00Z",
  "path": "/api/v1/resource",
  "message": "xx xx xx ",
  "ctx": {
    "workflowId": "some_wf_id",
    "stepId": "some_wf_id"
  },
  "errorId": "abc123"
}

{
  "statusCode": 404,
  "timestamp": "2024-12-12T13:00:00Z",
  "path": "/api/v1/resource",
  "message": "xx xx xx ",
  "ctx": {
    "workflowId": "some_wf_id",
    "stepId": "some_wf_id"
  },
  "errorId": "abc123"
}

{
  "statusCode": 404,
  "timestamp": "2024-12-12T13:00:00Z",
  "path": "/api/v1/resource",
  "message": "xx xx xx ",
  "ctx": {
    "workflowId": "some_wf_id",
    "stepId": "some_wf_id"
  },
  "errorId": "abc123"
}

{
  "statusCode": 404,
  "timestamp": "2024-12-12T13:00:00Z",
  "path": "/api/v1/resource",
  "message": "xx xx xx ",
  "ctx": {
    "workflowId": "some_wf_id",
    "stepId": "some_wf_id"
  },
  "errorId": "abc123"
}

{
  "statusCode": 404,
  "timestamp": "2024-12-12T13:00:00Z",
  "path": "/api/v1/resource",
  "message": "xx xx xx ",
  "ctx": {
    "workflowId": "some_wf_id",
    "stepId": "some_wf_id"
  },
  "errorId": "abc123"
}

{
  "statusCode": 404,
  "timestamp": "2024-12-12T13:00:00Z",
  "path": "/api/v1/resource",
  "message": "xx xx xx ",
  "ctx": {
    "workflowId": "some_wf_id",
    "stepId": "some_wf_id"
  },
  "errorId": "abc123"
}

{
  "statusCode": 404,
  "timestamp": "2024-12-12T13:00:00Z",
  "path": "/api/v1/resource",
  "message": "xx xx xx ",
  "ctx": {
    "workflowId": "some_wf_id",
    "stepId": "some_wf_id"
  },
  "errorId": "abc123"
}

{
  "statusCode": 404,
  "timestamp": "2024-12-12T13:00:00Z",
  "path": "/api/v1/resource",
  "message": "xx xx xx ",
  "ctx": {
    "workflowId": "some_wf_id",
    "stepId": "some_wf_id"
  },
  "errorId": "abc123"
}

{
  "statusCode": 404,
  "timestamp": "2024-12-12T13:00:00Z",
  "path": "/api/v1/resource",
  "errors": {
    "fieldName1": {
      "messages": [
        "Field is required",
        "Must be a valid email address"
      ],
      "value": "invalidEmail"
    },
    "fieldName2": {
      "messages": [
        "Must be at least 18 years old"
      ],
      "value": 17
    },
    "fieldName3": {
      "messages": [
        "Must be a boolean value"
      ],
      "value": true
    },
    "fieldName4": {
      "messages": [
        "Must be a valid object"
      ],
      "value": {
        "key": "value"
      }
    },
    "fieldName5": {
      "messages": [
        "Field is missing"
      ],
      "value": null
    },
    "fieldName6": {
      "messages": [
        "Undefined value"
      ]
    }
  },
  "message": "xx xx xx ",
  "ctx": {
    "workflowId": "some_wf_id",
    "stepId": "some_wf_id"
  },
  "errorId": "abc123"
}

"API rate limit exceeded"

{
  "statusCode": 404,
  "timestamp": "2024-12-12T13:00:00Z",
  "path": "/api/v1/resource",
  "message": "xx xx xx ",
  "ctx": {
    "workflowId": "some_wf_id",
    "stepId": "some_wf_id"
  },
  "errorId": "abc123"
}

"Please wait some time, then try again."

Retrieve a single channel endpoint by its identifier.

`tool_webhook` responses

For type: "tool_webhook", the response includes the wire shape { url, headers?, method? }. Internally, those fields are stored encrypted on the linked ChannelConnection.auth; the read path decrypts and re-hydrates them. Mask sensitive header values in your UI. The Novu dashboard shows only the last four characters of encrypted fields. See the Tool Webhook setup guide for how endpoint headers merge with integration defaults at delivery time.

Authorizations

Authorization

string

header

required

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

Headers

idempotency-key

string

A header for idempotency purposes

Path Parameters

identifier

string

required

The unique identifier of the channel endpoint

Response

identifier

string

required

The unique identifier of the channel endpoint.

channel

enum<string> | null

required

The channel type (email, sms, push, chat, etc.).

Available options:

in_app,

email,

sms,

chat,

push

providerId

enum<string> | null

required

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

Available options:

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,

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,

anthropic,

novu-anthropic,

anthropic-aws

Example:

"slack"

integrationIdentifier

string | null

required

The identifier of the integration to use for this channel endpoint.

Example:

"slack-prod"

connectionIdentifier

string | null

required

The identifier of the channel connection used for this endpoint.

Example:

"slack-connection-abc123"

subscriberId

string | null

required

The subscriber ID to which the channel endpoint is linked

Example:

"subscriber-123"

contextKeys

string[]

required

The context of the channel connection

Example:

["tenant:org-123", "region:us-east-1"]

type

enum<string>

required

Type of channel endpoint

Available options:

slack_channel,

slack_user,

webhook,

phone,

ms_teams_channel,

ms_teams_user,

telegram_chat,

webex_room,

webex_person,

line_user

Example:

"slack_channel"

endpoint

object

required

Endpoint data specific to the channel type

Show child attributes

createdAt

string

required

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

updatedAt

string

required

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

⌘I

TypeScript

import { Novu } from "@novu/api";

const novu = new Novu({
  secretKey: "YOUR_SECRET_KEY_HERE",
});

async function run() {
  const result = await novu.channelEndpoints.retrieve("<value>");

  console.log(result);
}

run();

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;

$sdk = novu\Novu::builder()
    ->setSecurity(
        'YOUR_SECRET_KEY_HERE'
    )
    ->build();



$response = $sdk->channelEndpoints->retrieve(
    identifier: '<value>'
);

if ($response->getChannelEndpointResponseDto !== null) {
    // handle response
}

package main

import(
	"context"
	"github.com/novuhq/novu-go/v3"
	"log"
	"github.com/novuhq/novu-go/v3/models/components"
)

func main() {
    ctx := context.Background()

    s := v3.New(
        v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
    )

    res, err := s.ChannelEndpoints.Retrieve(ctx, "<value>", nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.GetChannelEndpointResponseDto != nil {
        switch res.GetChannelEndpointResponseDto.Endpoint.Type {
            case components.EndpointTypeSlackChannelEndpointDto:
                // res.GetChannelEndpointResponseDto.Endpoint.SlackChannelEndpointDto is populated
            case components.EndpointTypeSlackUserEndpointDto:
                // res.GetChannelEndpointResponseDto.Endpoint.SlackUserEndpointDto is populated
            case components.EndpointTypeWebhookEndpointDto:
                // res.GetChannelEndpointResponseDto.Endpoint.WebhookEndpointDto is populated
            case components.EndpointTypePhoneEndpointDto:
                // res.GetChannelEndpointResponseDto.Endpoint.PhoneEndpointDto is populated
            case components.EndpointTypeMsTeamsChannelEndpointDto:
                // res.GetChannelEndpointResponseDto.Endpoint.MsTeamsChannelEndpointDto is populated
            case components.EndpointTypeMsTeamsUserEndpointDto:
                // res.GetChannelEndpointResponseDto.Endpoint.MsTeamsUserEndpointDto is populated
            case components.EndpointTypeTelegramChatEndpointDto:
                // res.GetChannelEndpointResponseDto.Endpoint.TelegramChatEndpointDto is populated
        }

    }
}

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.novu.co/v1/channel-endpoints/{identifier}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://api.novu.co/v1/channel-endpoints/{identifier}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "identifier": "<string>",
  "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"
  },
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

{
  "statusCode": 404,
  "timestamp": "2024-12-12T13:00:00Z",
  "path": "/api/v1/resource",
  "message": "xx xx xx ",
  "ctx": {
    "workflowId": "some_wf_id",
    "stepId": "some_wf_id"
  },
  "errorId": "abc123"
}

{
  "statusCode": 404,
  "timestamp": "2024-12-12T13:00:00Z",
  "path": "/api/v1/resource",
  "message": "xx xx xx ",
  "ctx": {
    "workflowId": "some_wf_id",
    "stepId": "some_wf_id"
  },
  "errorId": "abc123"
}

{
  "statusCode": 404,
  "timestamp": "2024-12-12T13:00:00Z",
  "path": "/api/v1/resource",
  "message": "xx xx xx ",
  "ctx": {
    "workflowId": "some_wf_id",
    "stepId": "some_wf_id"
  },
  "errorId": "abc123"
}

{
  "statusCode": 404,
  "timestamp": "2024-12-12T13:00:00Z",
  "path": "/api/v1/resource",
  "message": "xx xx xx ",
  "ctx": {
    "workflowId": "some_wf_id",
    "stepId": "some_wf_id"
  },
  "errorId": "abc123"
}

{
  "statusCode": 404,
  "timestamp": "2024-12-12T13:00:00Z",
  "path": "/api/v1/resource",
  "message": "xx xx xx ",
  "ctx": {
    "workflowId": "some_wf_id",
    "stepId": "some_wf_id"
  },
  "errorId": "abc123"
}

{
  "statusCode": 404,
  "timestamp": "2024-12-12T13:00:00Z",
  "path": "/api/v1/resource",
  "message": "xx xx xx ",
  "ctx": {
    "workflowId": "some_wf_id",
    "stepId": "some_wf_id"
  },
  "errorId": "abc123"
}

{
  "statusCode": 404,
  "timestamp": "2024-12-12T13:00:00Z",
  "path": "/api/v1/resource",
  "message": "xx xx xx ",
  "ctx": {
    "workflowId": "some_wf_id",
    "stepId": "some_wf_id"
  },
  "errorId": "abc123"
}

{
  "statusCode": 404,
  "timestamp": "2024-12-12T13:00:00Z",
  "path": "/api/v1/resource",
  "message": "xx xx xx ",
  "ctx": {
    "workflowId": "some_wf_id",
    "stepId": "some_wf_id"
  },
  "errorId": "abc123"
}

{
  "statusCode": 404,
  "timestamp": "2024-12-12T13:00:00Z",
  "path": "/api/v1/resource",
  "message": "xx xx xx ",
  "ctx": {
    "workflowId": "some_wf_id",
    "stepId": "some_wf_id"
  },
  "errorId": "abc123"
}

{
  "statusCode": 404,
  "timestamp": "2024-12-12T13:00:00Z",
  "path": "/api/v1/resource",
  "errors": {
    "fieldName1": {
      "messages": [
        "Field is required",
        "Must be a valid email address"
      ],
      "value": "invalidEmail"
    },
    "fieldName2": {
      "messages": [
        "Must be at least 18 years old"
      ],
      "value": 17
    },
    "fieldName3": {
      "messages": [
        "Must be a boolean value"
      ],
      "value": true
    },
    "fieldName4": {
      "messages": [
        "Must be a valid object"
      ],
      "value": {
        "key": "value"
      }
    },
    "fieldName5": {
      "messages": [
        "Field is missing"
      ],
      "value": null
    },
    "fieldName6": {
      "messages": [
        "Undefined value"
      ]
    }
  },
  "message": "xx xx xx ",
  "ctx": {
    "workflowId": "some_wf_id",
    "stepId": "some_wf_id"
  },
  "errorId": "abc123"
}

"API rate limit exceeded"

{
  "statusCode": 404,
  "timestamp": "2024-12-12T13:00:00Z",
  "path": "/api/v1/resource",
  "message": "xx xx xx ",
  "ctx": {
    "workflowId": "some_wf_id",
    "stepId": "some_wf_id"
  },
  "errorId": "abc123"
}

"Please wait some time, then try again."

Getting Started

Notification delivery

Agents

Data

Workflows & content

Platform & channels

Retrieve a channel endpoint

`tool_webhook` responses

Authorizations

Headers

Path Parameters

Response

​tool_webhook responses

Authorizations

Headers

Path Parameters

Response

`tool_webhook` responses