NOnovu
Channel Endpoints

Create a channel endpoint

Changed on

Create a new channel endpoint for a resource.

post/v1/channel-endpoints

Request

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

Headers

idempotency-keystring

A header for idempotency purposes

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "identifier": "slack-channel-user123-abc4",
  "subscriberId": "subscriber-123",
  "integrationIdentifier": "slack-prod",
  "connectionIdentifier": "slack-connection-abc123",
  "type": "slack_channel",
  "endpoint": {
    "channelId": "C123456789"
  }
}

Response

Created

identifierstring required

The unique identifier of the channel endpoint.

channel'in_app' | 'email' | 'sms' | 'chat' | 'push' | 'tool' nullable required

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

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' nullable required

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

integrationIdentifierstring nullable required

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

connectionIdentifierstring nullable required

The identifier of the channel connection used for this endpoint.

subscriberIdstring nullable required

The subscriber ID to which the channel endpoint is linked

contextKeysstring[] required

The context of the channel connection

type'slack_channel' | 'slack_user' | 'webhook' | 'phone' | 'ms_teams_channel' | 'ms_teams_user' | 'telegram_chat' | 'webex_room' | 'webex_person' | 'line_user' | 'pagerduty_service' | 'opsgenie_integration' | 'grafana_oncall_integration' | 'tool_webhook' required

Type of channel endpoint

createdAtstring required

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

updatedAtstring required

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

Example response

{
  "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
    • warning

      changed the pattern of the request property ///////// from /^[a-zA-Z0-9]{32}$/ to ^[a-zA-Z0-9]{32}$

    • info

      removed the pattern GRAFANA_ONCALL_WEBHOOK_URL_PATTERN from the request property /////////

    • info

      removed the pattern OPSGENIE_API_KEY_PATTERN from the request property /////////

    • 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