API Reference

entri.showEntri(config)

This method launches the Entri modal window. config is an object with the following properties:

PropertyTypeRequired?DefaultDescription
applicationIdstringYesN/AThe ID of your application (set in the dashboard)
tokenstringYesN/AA JSON web token. Must be fetched in each session, see Installation.
dnsRecordsarray of DNSRecord objects (see below)YesN/AThe DNS records you wish to configure for your users (see below)
prefilledDomainstringNo, unless forceManualSetup is set to trueN/AA domain to pre-fill if you've collected it before the Entri modal, e.g. example.com
userIdstringNoN/AA unique ID so that you can match Entri webhook events to the user
supportForSubdomainsbooleanNotrueIf your application allows subdomains, enable this
forceSubdomainbooleanNofalseIf your application requires subdomains, enable this
manualSetupDocumentationstringNo""Where you currently provide documentation on how to set up DNS. If users are trying to set up their DNS manually and need help, we will send them to this page. e.g. <https://example.com/docs/dns-setup>. This link is disabled when using the propertydisableManualSetupDocumentationLink:true in the whiteLabel's configuration.
enableDkimbooleanNofalseIf your application requires users to set up DKIM through their email provider (and your app does not send emails directly), enable this. This is common for applications that provide email automation using an external service like Google Workspace or Microsoft 365.
defaultSubdomainstringNo""If you would like to pre fill the subdomain field with text then enter the desired sub domain here.
hostRequiredbooleanNo, unless you use the {SUBDOMAIN} variabletrueIf the {SUBDOMAIN} variable is used but is null (no subdomain inputted by the user) then the {SUBDOMAIN} value will default to be www. See Dynamic configuration variables based on the user-inputted domain.
wwwRedirectbooleanNofalseWhen feasible, Entri will automatically redirect site.com to www.site.com using the preferred method of the DNS provider. Certain providers prevent Entri from automatically setting this up. When that is the case, Entri shows a helper UI to the user that explains how to do this manually.
localestringNoenTo load Entri in a specific language. Supported languages include: en, es, pt, pt-br,pt-pt, fr, it, de, nl, pl, tr, ja.
The pt locale defaults to Brazilian portuguese (pt-br).
forceManualSetupbooleanNofalseForces Entri to use the manual setup flow. If set to true then the prefilledDomain becomes required.
applicationUrlstringOnly when using PowerN/ASets the applicationUrlfor Power. This is the specific application URL that you would like to render on the customer's custom domain. Also known as an origin server or origin URL.
powerbooleanNofalseEnables Entri Power.

dnsRecords object

DNS records can have the following properties:

PropertyTypeRequired?Example
typestring (see below)YesCNAME Check the Supported record types section below
hoststringYeswww
valuestringYesm.example.com
ttlintegerYes300
priorityintegerOnly for MX records10
fallbackValuestringNov=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDg9/gR+3J0mmugLjhpYOfQK9ytkEKnXM0kVdpu0UoykSPK7ChD+nRxFJbN2cxtvu8GrCNQwPTKbC0jimaSi0V2j3JndnRrECuYCqeZYcRmw2lYs18QnmJRfCpweKoaGtv9zERCkeHwLcTaLkrSHrRDf58WgERg8x/4ipBPIyZufwIDAQAB

whiteLabel object

The whiteLabel property object allows you to further customize the Entri Modal UI. Please note you may need an Enterprise level account for these properties to be available. For questions about this, contact your account manager.

PropertyTypeRequired?DefaultDescription
hideEntriLogobooleanNofalseWhen true, hides all mentions of "Powered by Entri"
hideConfettibooleanNofalseWhen true, hides the confetti upon a successful domain configuration.
hideLinkSharingConfirmationbooleanNofalseRemoves the "I have shared the link" check from the sharing link feature modal.
logostringNonullThis needs to be an https URL. When inputted, it will remove the Entri logo and use your custom logo. We recommended an SVG or PNG file that is 1:1.
logoBackgroundColorstringNonullWhen present, this will set a background color for the logo mask. Useful if your logo uses a white color and has a transparent background.
removeLogoBorderbooleanNofalseWhen true, this will remove the rounded mask/border that is applied over your logo.
removeShareLoginbooleanNofalseWhen true, this will remove the sharing link functionality across the whole app.
themeobjectNonullDescribed below (see theme Object)

theme Object

The theme object allows you to customize the foreground and background colors to match your app's branding. Please note you may need an Enterprise level account for these properties to be available. For questions about this, contact your account manager.

PropertyTypeDefaultDescription
bgstringN/ABackground color. Please input a hex code.
fgstringN/AForeground color. Please input a hex code.
linksstringN/ALinks color to override HTML's default blue.

customCopy Object

The customCopy object allows you to customize certain texts along the flow, in order to match your brand's tone or in case the default copy doesn't exactly fit your use case. Entri has
The default and only required locale (translation) needed to used in the customCopy object is the EN locale. All missing translations will default to English.

Please note you may need an Enterprise level account for these properties to be available. For questions about this, contact your account manager.

PropertyTypeDefaultDescription
initialScreenobjectnullContains the title and/or subtitle override details
initialScreen.titleobjectnullOverrides the title on the initial screen.
initialScreen.title.${locale}stringnullSets the title's translation text for the specific locale (one of the available codes such as en,es,fr, etc., for example initialScreen.title.en). If no matching translation is found for the locale in use, then the Entri's default text will be used. Please find the full list of available locales on locale property's documentation.
initialScreen.subTitleobjectnullOverrides the subtitle on the initial screen
initialScreen.subTitle.${locale}stringnullSets the subtitle's translation text for the specific locale. (one of the available codes, such as en,es,fr, etc., for example initialScreen.title.en). If no matching translation is found for the locale in use, then the Entri's default text will be used. Please find the full list of available locales on locale property's documentation.
manuallyScreenobjectnullContains the step-by-step-guide override details.
manuallyScreen.disableManualSetupDocumentationLinkbooleanfalseDisables the opening of the documentation URL provided in the manualSetupDocumentation configuration property. Commonly used in combination with in combination with the onEntriManualSetupDocumentationClick event to trigger a custom js function.
manuallyScreen.stepByStepGuideobjectnullOverrides the step-by-step-guide line of text on the manual configuration screen
manuallyScreen.stepByStepGuide.${locale}stringnullSets the step-by-step-guide translation text for the specific locale (one of the available codes, such as en,es,fr, etc., for example initialScreen.title.en). If no matching translation is found for the locale in use, then the Entri's default text will be used. Please find the full list of available locales on locale property's documentation.
This field also supports links for triggering javascript functions only. These are helpful for triggering chatbots or other actions. You only need to enclose the call to action text inside the <link></link> tags to create an "empty" link, and then catch the onEntriManualSetupDocumentationClick event.

White label code example:

{
  "whiteLabel": {
    "hideEntriLogo": true,
    "hideConfetti": true,
    "logo": "LOGO_URL",
    "theme": {
      "fg": "#fff",
      "bg": "#fa7268"
    },
    "logoBackgroundColor": "#444444",
    "removeLogoBorder": true,
    "customCopy": {
      "initialScreen": {
        "title": {
          "en": "Custom title",
          "es": "Título custom"
        },
        "subtitle": {
          "en": "Custom subtitle",
          "es": "Subtítulo custom"
        }
      },
      "manuallyScreen": {
        "disableManualSetupDocumentationLink": true,
        "stepByStepGuide": {
          "en": "Follow our <link>step-by-step</link> guide",
          "es": "Sigue nuestra guía <link>paso-a-paso</link>"
        }
      }
    }
  }
}


onEntriClose Callback Event

Sample usage:

function handleOnEntriClose(event) {
  console.log('onEntriClose', event.detail);
}
window.addEventListener('onEntriClose', handleOnEntriClose, false);

Sample event.detail object response:

{
  domain: "example.com", 
  success: true, 
  setupType: "automatic", 
  provider: "Provider name", 
  lastStatus: "IN_PROGRESS"
}

Properties description

NameTypeDescription
domainstringDomain that the user entered. Can be null if the user exits before entering a domain.
successbooleanWas the setup of the domain completed?
setupTypestringType of DNS setup. Can be "automatic", "manual", "sharedLogin" or null if the user didn't reach the set up stage.
providerstringProvider name used to configure the domain or "unknown" if it was not detected.
lastStatusstringlastStatus can be used if you want more information about where the user dropped off. Find all possible values below.

lastStatus possible values

lastStatusDescription
FINISHED_SUCCESSFULLYThe user has successfully configured their domain using the automatic flow.
IN_PROGRESSThe user exited the Entri modal while the DNS setup was in progress.
EXISTING_RECORDSThe user exited the Entri modal when prompted if they want to override an existing set of DNS records.
LOGINThe user exited the Entri modal flow during the login process (when prompted for their login credentials and/or 2FA verification)
MANUAL_CONFIGURATIONThe user exited the Entri modal after manual DNS configuration instructions were presented.
EXIT_WITH_ERRORThe user exited the Entri modal after an error occurred.
DKIM_SETUPThe user exited the Entri modal after prompting

onEntriManualSetupDocumentationClick Event

This event is triggered when the user has clicked on the "Follow our step-by-step guide" link on the Manual configuration screen. It doesn't include any additional information within the event.detail object.

Sample usage:

function myCustomFunction(event) {
  //Custom code here
}
window.addEventListener('onEntriManualSetupDocumentationClick', myCustomFunction, false);

Supported Record Types

TypeDescription
AHolds the IP address of a domain.
AAAAThe AAAA record is conceptually similar to the A record, but it allows you to specify the IPv6 address of the server, rather than the IPv4.
CNAMEForwards one domain or subdomain to another domain. Does not provide an IP address.
CAAUsed to provide additional confirmation for the Certification Authority (CA) when validating an SSL certificate.
MXDirects email to an email server.
TXTStores text strings. For special uses of the TXT record, see Handling DKIM, SPF, and DMARC records.
NSIndicates which DNS server is authoritative for that domain, it is the server that stores all DNS records for a domain, including A records, MX records, or CNAME records.

entri.checkDomain(domain, config)

This asynchronous method checks if Entri supports automatic setup for a particular domain. It accepts two arguments:

ArgumentTypeExample
domainstring - a domain with no subdomainexample.com
configEntri configuration objectSee above

Important note: checkDomain function also requires you to provide the JWT authentication key within the configuration object. Refer to JWT authentication section for more information.

Sample usage:

const domainCheck = await entri.checkDomain("mydomain.com", config)

Sample response:

{
    "provider": "Cloudflare", //Provider name or `Unknown`
    "setupType": "Automatic", // `Automatic` or `Manual`
    "NSSupport": {
        "root": true, //NS modifications support for the root domain for this provider
        "subdomains": true //NS modifications support for subdomains for this provider
    }
}

entri.purchaseDomain(config)

This method launches the Entri Sell window. config is an object with the same properties as the specified in entri.showEntri(config) plus a Sell-specific options:

PropertyTypeRequired?DefaultDescription
disableConnectbooleanNofalseIf true then the flow will only run the domain(s) purchase flow, but no specific DNS records will get configured.
debugModebooleanNofalseFor testing purposes. It skips the actual domain purchase flow and checkout and takes the user back to the DNS records setup step. IMPORTANT!: this should only be used with pre-existent IONOS registered domains.

Asynchronous DNS configurations (Entri Sell only)

You can make asynchronous DNS configurations after the initial Entri Sell flow has finished for up to 3 days after the initial domain purchase. You will only need to use the following endpoint with the proper DNS records information:

POST https://api.goentri.com/connect/async
Header "Authorization: [JWT authorization]"
Header "applicationId: [yourApplicationID]

Sample body:

{
  "applicationId": "clickfunnels",
  "domain": "domain.com",
  "subdomain": "www",
  "wwwRedirect": false,
  "dnsRecords": [
    {
      "value": "13.248.155.104",
      "host": "@",
      "ttl": 300,
      "type": "A"
    }
  ]
}

Properties:

TypePropertyRequired?DefaultDescription
stringapplicationIdYesN/AThe ID of your application (set in the dashboard)
stringdomainYesN/AThe domain that will have the DNS records configured, e.g. example.com
array of DNSRecord objects (check ref)dnsRecordsYesN/AThe DNS records you wish to configure for your users (check ref)
stringsubdomainNoN/AThe subdomain that will have the DNS records configured, e.g. www
booleanwwwRedirectNofalseIf true, Entri will automatically set the redirect from the bare domain to the www subdomain.

Webhooks

Entri sends JSON data via webhook to notify your backend when events occur. For example:

{
  "id": "028b5078-8fed-4ffb-8e3e-3e6e6d8214b4",
  "user_id": "sample-user",
  "domain": "smallbusiness.com",
  "type": "domain.added",
  "propagation_status": "success",
  "dkim_status": "success",
  "redirection_status": "exempt",
  "ssl_status": "success",
  "setup_type": "automatic",
  "secure_status": "success", //Only for Entri Secure usage
  "power_status" : "success", //Only for Entri Power usage
  "cname_target": "my.saascompany.com", //Only for Entri Power and Secure usage
  "purchased_domains": ["domain1.com",...,"domainN.com"], //Only for Entri Sell usage
  "data": {
    "records_propagated": [
      {
        "type": "A",
        "host": "smallbusiness.com",
        "value": "54.153.2.220"
      },
      {
        "type": "CNAME",
        "host": "www",
        "value": "smallbusiness.com"
      }
    ],
    "records_non_propagated": [],
    "updated_objects": [
      "propagation_status",
      "ssl_status"
    ]
  }
}

The JSON object contains the following properties:

PropertyTypeDescription
idstringEntri's ID for the webhook event
user_idstringThe user ID that your application can optionally send via the configuration object during setup (see the entri.showEntri method)
domainstringThe domain name set by your user
typestringThe event type. Options:

- domain.added
- domain.timeout
- domain.purchased
setup_typestringStates if the dns record(s) was done in a manual or automatic way. Options:
- automatic
- manual
propagation_statusstringThe DNS propagation status. Options:

- success
- pending
- failure
dkim_statusstringWhether DKIM has been set up (see Handling DKIM, SPF, and DMARC Records). Options:

- success
- pending
- failure
- exempt (the feature is disabled)
redirection_statusstringIf the wwwRedirect feature was enabled for your applicationId, then Entri will check to confirm the status of the url redirect.

Options:

- success
- pending
- failure
- exempt (the feature is disabled)
data.records_propagatedarray of DNSRecord objectsSee above
data.records_non_propagatedarray of DNSRecord objectsSee above
updated_objectsarray of stringsThe object properties that have been updated since the last webhook event.
secure_statusstringWhether an SSL certificate has been provisioned (see Provisioning SSL Certificates). Options:

- success
- pending
- failure
- exempt (the feature is disabled)
power_statusstringWhether a domain has been powered (see Powering domains). Options:

- success
- pending
- failure
- exempt (the feature is disabled)
cname_targetstringAccount's configured cname_target value for Entri Power and Secure or empty string if it doesn't apply.
purchased_domainsarray of stringsList of purchased domains along the Entri Sell flow or empty array if not an Entri Sell flow.

Secure - SSL certificates

Check the domain's eligibility

GET https://api.goentri.com/ssl?domain=www.example.com
Header "Authorization: [JWT authorization]"
Header "applicationId: [yourApplicationID]"

Successful response (200 status)

{
  // Is the domain CNAMEed to the cname_target of the application?
  "eligible": true | false,
  
  // Is SSL provisioned?
  "sslStatus": "active" | "inactive",

  // Current cnameTarget set on the Dashboard
  "cnameTarget": URL | "",
  
  // Current cnameTarget value for the domain
  "applicationUrl": URL | ""
}

Possible error responses

Errors are returned as a {message: 'string'} object.

Error messageStatus
Domain provided couldn't be resolved.400

Provision an SSL certificate

POST https://api.goentri.com/ssl
Header "Authorization: [JWT authorization]"
Header "applicationId: [yourApplicationID]"

Request body

{ 
  "domain": "www.example.com",
  /*Optional*/ "applicationUrl": "my.applicationurl.com" 
}

Successful response (200 status)

{ "message": "Success." }

Possible error responses

Errors are returned as a {message: 'string'} object.

Error messageStatus
There is already a valid certificate for this domain.502
Please review SSL eligibility status of this domain.502
Please complete step 1.502
Internal Server Error.502
ApplicationUrl is not reachable502

Renew an SSL certificate

PUT https://api.goentri.com/ssl
Header "Authorization: [JWT authorization]"
Header "applicationId: [yourApplicationID]"

Request body

{ "domain": "www.example.com" }

Successful response (200 status)

{ "message": "Success." }

Possible error responses

Errors are returned as a {message: 'string'} object.

Error messageStatus
{detailed error message when renewing the domain}502

Deprovision an SSL certificate

DELETE https://api.goentri.com/ssl
Header "Authorization: [JWT authorization]"
Header "applicationId: [yourApplicationID]"

Request body

{ "domain": "www.example.com" }

Successful response (200 status)

{ "message": "Success." }

Possible error responses

Errors are returned as a {message: 'string'} object.

Error messageStatus
Domain not valid502
{detailed error message when deleting the SSL certificate of the domain}502

Power - Custom domains

Check the domain's eligibility

GET https://api.goentri.com/power?domain=www.example.com
Header "Authorization: [JWT authorization]"
Header "applicationId: [yourApplicationID]"

Successful response (200 status)

{
  // Is the domain CNAMEed to the cname_target of the application?
  "eligible": true | false,
  
  // Is the domain already powered?
  "powerStatus": "active" | "inactive",

  // Current cnameTarget set on the Dashboard
  "cnameTarget": URL | "",
  
  // Current cnameTarget value for the domain
  "applicationUrl": URL | "",

  //Paths with granted access to the root of the Application URL
  "powerRootPathAccess": [] | ["/path1", "/path2",..., "pathN"]
}

Possible error responses

Errors are returned as a {message: 'string'} object.

Error messageStatus
Domain provided couldn't be resolved.400

Power a new domain

POST https://api.goentri.com/power
Header "Authorization: [JWT authorization]"
Header "applicationId: [yourApplicationID]"

Request body

{ 
  "domain": "www.example.com",
  /*Optional*/ "applicationUrl": "my.applicationurl.com",
  /*Optional*/ "powerRootPathAccess: ['/path1', '/path2',..., '/pathN']
}

Successful response (200 status)

{ "message": "Success." }

Possible error responses

Errors are returned as a {message: 'string'} object.

Error messageStatus
This domain has been already powered.502
Please review Power eligibility status of this domain.502
Please complete step 1.502
Internal Server Error.502

Update an already powered a domain

PUT https://api.goentri.com/power
Header "Authorization: [JWT authorization]"
Header "applicationId: [yourApplicationID]"

Request body

{ 
  "domain": "www.example.com",
  /*Optional*/ "applicationUrl": "my.applicationurl.com",
  /*Optional*/ "powerRootPathAccess: ['/path1', '/path2',..., '/pathN']
}

Successful response (200 status)

{ "message": "Success." }

Possible error responses

Errors are returned as a {message: 'string'} object.

Error messageStatus
{detailed error message when powering again the domain}502

Remove a powered domain

DELETE https://api.goentri.com/power
Header "Authorization: [JWT authorization]"
Header "applicationId: [yourApplicationID]"

Request body

{ "domain": "www.example.com" }

Successful response (200 status)

{ "message": "Success." }

Possible error responses

Errors are returned as a {message: 'string'} object.

Error messageStatus
Domain not valid502
{detailed error message when deleting the SSL certificate of the domain}502