Create channel connection for a resource and integration
Create a new channel connection for a resource for given integration. Only one channel connection is allowed per resource and integration.
Authorization
Authorization<token>API key authentication. Allowed headers-- "Authorization: ApiKey <novu_secret_key>".
In: header
Request Body
application/jsonRequiredidentifierstringThe unique identifier for the channel connection. If not provided, one will be generated automatically.
subscriberIdstringThe subscriber ID to link the channel connection to
contextobjectintegrationIdentifierRequiredstringThe identifier of the integration to use for this channel connection.
workspaceRequiredobjectauthRequiredobjectHeader 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.
subscriberIdRequiredstring | nullThe subscriber ID to which the channel connection is linked
contextKeysRequiredarray<string>The context of the channel connection
workspaceRequiredobjectauthRequiredobjectcreatedAtRequiredstringThe 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.