Entri Connect is the easiest way for your users to connect domains.
showEntri
method with your configuration object to trigger the Entri modal to appear.
onEntriClose
callback eventlastStatus
field. For a full description of all lastStatus
fields, see here: https://developers.entri.com/api-reference#onentriclose-callback-event-datalaststatus-fields
When you receive the callback event you can display a success message in your application or move the user to a next step—whatever works best in your flow.
prefilledDomain
should not contain www.
It should
be a naked domain. * At this time, Entri does not handle domain validation
when you send a domain using the prefilledDomain variable. You’ll need to
handle validation in your application’s UI.userId
to track events via Entri webhooksuserId
to the configuration object. This should be the same ID that the backend of your application uses.
checkDomain
method. This will tell you in advance whether the process fully automatic for your users or if they’ll be asked to handle the DNS setup manually.
It takes two arguments:
then()
or using the await
operator—whatever works best in your application.
NSSupport
object specifies whether Entri is able to execute Nameserver changes at the root
and/or subdomains
levels.
dnsRecords
section of your configuration object using {}
syntax.
For example, if the user sets up blog.example.com
, the following variables will be available:
{DOMAIN}
= example.com
{SUBDOMAIN}
= blog
{SLD}
= example
{TLD}
= com
{emailProviderSPF}
for email provider SPF records. It outputs different values depending on the provider:
include:_spf.google.com
include:spf.protection.outlook.com
include:zoho.com
CustomEvent
entri.showEntri()
method, you can launch the Entri modal using a CustomEvent: