Create channel endpoint for a resource
Create a new channel endpoint for a resource.
Authorization
Authorization<token>API key authentication. Allowed headers-- "Authorization: ApiKey <novu_secret_key>".
In: header
Authorization<token>API key authentication. Allowed headers-- "Authorization: ApiKey <novu_secret_key>".
In: header
Request Body
application/jsonRequiredChannel endpoint creation request. The structure varies based on the type field.
bodyRequiredobject | object | object | object | object | objectHeader Parameters
idempotency-keystringA header for idempotency purposes
Response Body
Created
identifierRequiredstringThe unique identifier of the channel endpoint.
channelRequiredstring | nullThe channel type (email, sms, push, chat, etc.).
"in_app" | "email" | "sms" | "chat" | "push"providerIdRequiredstring | nullThe provider identifier (e.g., sendgrid, twilio, slack, etc.).
"emailjs" | "mailgun" | "mailjet" | "mandrill" | "nodemailer" | "postmark" | "sendgrid" | "sendinblue" | "ses" | "netcore" | "infobip-email" | "resend" | "plunk" | "mailersend" | "mailtrap" | "clickatell" | "outlook365" | "novu-email" | "sparkpost" | "email-webhook" | "braze" | "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" | "fcm" | "apns" | "expo" | "one-signal" | "pushpad" | "push-webhook" | "pusher-beams" | "appio" | "novu" | "slack" | "discord" | "msteams" | "mattermost" | "ryver" | "zulip" | "grafana-on-call" | "getstream" | "rocket-chat" | "whatsapp-business" | "chat-webhook" | "novu-slack"integrationIdentifierRequiredstring | nullThe identifier of the integration to use for this channel endpoint.
connectionIdentifierRequiredstring | nullThe identifier of the channel connection used for this endpoint.
subscriberIdRequiredstring | nullThe subscriber ID to which the channel endpoint is linked
contextKeysRequiredarray<string>The context of the channel connection
typeRequiredstringType of channel endpoint
"slack_channel" | "slack_user" | "webhook" | "phone" | "ms_teams_channel" | "ms_teams_user"endpointRequiredobject | object | object | objectEndpoint data specific to the channel type
createdAtRequiredstringThe timestamp indicating when the channel endpoint was created, in ISO 8601 format.
updatedAtRequiredstringThe timestamp indicating when the channel endpoint was last updated, in ISO 8601 format.