Sign in
Channel Endpoints

Create a channel endpoint

Create a new channel endpoint for a resource.

post/v1/channel-endpoints

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

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

  • 24e82408dec711See the full diff
    • ●

      added the new novu-web-chat enum value to the providerId response property for the response status 201

      response-property-enum-value-added

    • ○

      removed the novu-agent-chat enum value from the providerId response property for the response status 201

      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

  • c2b2fa0d5d4811See the full diff
    • ●

      added the new novu-agent-chat enum value to the providerId response property for the response status 201

      response-property-enum-value-added

    • ○

      removed the novu-web-chat enum value from the providerId response property for the response status 201

      response-property-enum-value-removed

  • 8092e41edd57142See the full diff
    • ▲

      added GrafanaOnCallIntegrationEndpointDto ToolWebhookEndpointDto to the endpoint response property oneOf list for the response status 201

      response-property-one-of-added

    • ●

      added the new grafana enum value to the providerId response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new grafana_oncall_integration enum value to the type response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new novu-web-chat enum value to the providerId response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new tool_webhook enum value to the type response property for the response status 201

      response-property-enum-value-added

    • ○

      added grafana_oncall_integration tool_webhook mapping keys to the request discriminator

      request-body-discriminator-mapping-added

    • ○

      added CreateGrafanaOnCallIntegrationEndpointDto CreateToolWebhookEndpointDto to the request body oneOf list

      request-body-one-of-added

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

  • ab1c5d528f971See the full diff
    • ●

      added the new ruach-sms enum value to the providerId response property for the response status 201

      response-property-enum-value-added

  • c69777f601841139See the full diff
    • ▲

      added WebexRoomEndpointDto WebexPersonEndpointDto LineUserEndpointDto PagerDutyServiceEndpointDto OpsgenieIntegrationEndpointDto to the endpoint response property oneOf list for the response status 201

      response-property-one-of-added

    • ●

      added the new anypost enum value to the providerId response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new line enum value to the providerId response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new line_user enum value to the type response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new opsgenie enum value to the providerId response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new opsgenie_integration enum value to the type response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new pagerduty enum value to the providerId response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new pagerduty_service enum value to the type response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new sendblue enum value to the providerId response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new tool enum value to the channel response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new tool-webhook enum value to the providerId response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new webex-messaging enum value to the providerId response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new webex_person enum value to the type response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new webex_room enum value to the type response property for the response status 201

      response-property-enum-value-added

    • ○

      added the new optional request property oneOf[CreateMsTeamsChannelEndpointDto]/createSubscriberIfMissing

      new-optional-request-property

    • ○

      added the new optional request property oneOf[CreateMsTeamsUserEndpointDto]/createSubscriberIfMissing

      new-optional-request-property

    • ○

      added the new optional request property oneOf[CreatePhoneEndpointDto]/createSubscriberIfMissing

      new-optional-request-property

    • ○

      added the new optional request property oneOf[CreateSlackChannelEndpointDto]/createSubscriberIfMissing

      new-optional-request-property

    • ○

      added the new optional request property oneOf[CreateSlackUserEndpointDto]/createSubscriberIfMissing

      new-optional-request-property

    • ○

      added the new optional request property oneOf[CreateTelegramChatEndpointDto]/createSubscriberIfMissing

      new-optional-request-property

    • ○

      added the new optional request property oneOf[CreateWebhookEndpointDto]/createSubscriberIfMissing

      new-optional-request-property

    • ○

      added webex_room webex_person line_user pagerduty_service opsgenie_integration mapping keys to the request discriminator

      request-body-discriminator-mapping-added

    • ○

      added CreateWebexRoomEndpointDto CreateWebexPersonEndpointDto CreateLineUserEndpointDto CreatePagerDutyServiceEndpointDto CreateOpsgenieIntegrationEndpointDto to the request body oneOf list

      request-body-one-of-added