Webhookregistration


The Webhookregistration module is configured to allow external registration providers to create new users in KMS, grant them access to an entry or a channel and then send a confirmation email to the registrant email address with a magic link to access the entry/channel/home page.

version1.0.0

FieldDescription
enabledEnablethe  Webhookregistration  module.
createPreRegisteredUser
When enabled, a user will be created immediately when the webhook is sent. The user attendanceInfo will be with status 'Pre-registered' and the user status will be Blocked.
registrationKey
key to validate request.
userPool
ognito user pools
userPoolId
Cognito user pool id
region
region used in the user pool
Add "allowedAddressesrovide IPs or ranges to allow access to the webhook registration action. if none configured, access is allowed to IPs. Examples: 192.168.1.1 | 192.168.1.1/255.255.0.0 | 192.168.1.1/24 | 192.168.1.0-192.168.1.240
magicLinkExpiry
The duration, in seconds, for which the link will be accessible (starting from the moment the email is generated).
setPasswordLinkExpiry
The duration, in seconds, for which the link will be accessible (starting from the moment the email is generated).
emailAction
When set to 'magiclink' the email will include a KS allowing the user to login and watch the event; when set to 'Set Password', the link will allow the user to set their Cognito password and login.
defaultRole
The user application role to be set for newly created users.
defaultJoinLinkExpiry
Event Join Link expiry in seconds
eventName
The event name will be used when emailing if the eventId provided does not resolve to a valid entry ID.
registerLink
Link to the event registration form.
You can use {FNAME}, {LNAME} and {EVENT_NAME} to dynamically populate the registration info.
defaultConfirmationEmailBody
You can use {FNAME}, {LNAME}, {EVENT_NAME} and {MAGIC_LINK} to dynamically populate the registration info. HTML tags are supported.
registrationEmailFrom
The email that registration email messages are sent from.
sendCognitoLanguage

fieldMapping
Click +Add :"fieldMapping"  to add field mapping.
emailLanguageParamName
The name of language parameter received by set password request.
setPasswordSuccessEmailLocal
The list of email templates per language for the set-password-success email.
tokensClick "+Add "tokens.
tokenName
The token name as appears in the email template.
tokenValue
The token value.
languagesClick "+Add "languages.
language
The language value as sent via the webhook.
templateName
The email template name for this language.
setPasswordFailEmailLocal
The list of email templates per language for the set-password-success email.
tokens
Click "+Add "tokens.
tokenName
The token name as appears in the email template.
tokenValueThe token value.
languages
Click "+Add "languages.
languageThe language value as sent via the webhook.
templateNameThe email template name for this language.
languageMapping
click +Add "languageMapping
externalLanguageCode

language

Was this article helpful?
Thank you for your feedback!
In This Article
Related Articles
Back to top

Never miss a thing!

Subscribe to our customer newsletter and our release notes updates, so you always get the best out of Kaltura.
Newsletter