​

entri.showEntri(config)

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

​

dnsRecords object

DNS records can be provided in two different ways, using a single array of records or an object with the array of records specified the domain and subdomain cases.

​

Record object specification

​

Simple array

A single array of dns records. This is the easiest way to send Entri the set of records you want to configure for all on all domains with no subdomain/domain distinction.

{
  ...,
  dnsRecords: [
    {
      type: "CNAME",
      host: "shop",
      value: "myapp.com",
      ttl: 300,
    },
    {
      type: "TXT",
      host: "@",
      value: "123-example-txt-record",
      ttl: 300,
    }
  ]
}

​

Conditional records object

If you have different sets of records you need to configure depending on whether it is a domain or a subdomain, then this is the best option for you. You just need to include the two sets of records into separate objects, making use of the domain, subDomain and rootNS If the rootNS key is found within the conditional records object, it will have precedence over the other two. If the detected or manually-selected provider does not count with NS modifications support, then the domain/subDomain approach will be used instead.

Sample conditional records object:

{
  ...,
  dnsRecords: {
    domain: [
      {
        type: "A",
        host: "@",
        value: "1.2.3.4",
        ttl: 300,
      },
      {
        type: "TXT",
        host: "@",
        value: "123-example-txt-record",
        ttl: 300,
      }
    ],
    subDomain: [
      {
        type: "CNAME",
        host: "shop",
        value: "myapp.com",
        ttl: 300,
      },
      {
        type: "TXT",
        host: "@",
        value: "123-example-txt-record",
        ttl: 300,
      }
    ],
    rootNS: [
      {
        type: "NS",
        host: "@",
        value: "ns1.sampleprovider.com",
        ttl: 300,
      },
      {
        type: "NS",
        host: "@",
        value: "ns2.sampleprovider.com",
        ttl: 300,
      }
    ]
}

​

Multi-domain flows

With Entri, you can configure as many domains as you need using the end user flow. In order to achieve it, you only need to use a similar dnsRecords structure as the conditional records, in combination with the array form of the prefilledDomain property.

This is a sample configuration for a multi-domain flow:

{
  //...
  prefilledDomain: ["firstDomain.com", "secondDomain.com"],
  dnsRecords: {
    "firstDomain.com": [
      {
        type: "A",
        host: "@",
        value: "1.2.3.4",
        ttl: 300,
      },
      {
        type: "TXT",
        host: "@",
        value: "123-example-txt-record",
        ttl: 300,
      }
    ],
    "secondDomain.com": [
      {
        type: "CNAME",
        host: "shop",
        value: "myapp.com",
        ttl: 300,
      },
      {
        type: "TXT",
        host: "@",
        value: "123-example-txt-record",
        ttl: 300,
      }
    ]
}

​

Dynamic configuration variables

You can insert dynamic variables into the dnsRecords section of your configuration object using syntax.

For example, if the user sets up blog.example.com, the following variables will be available:

​

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.

​

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.

Entri Connect Theme Options

Entri Sell Theme Options

​

icons Object

The icons object allows you to customize the default icons used across the flow.

​

customProperties Object

The customProperties object allows you to set different behaviours related specifically to specific elements or a screen’s behavior.

​

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. The default and only required locale (translation) needed to be used within 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.

​

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>"
        }
      }
    }
  }
}

​

Supported Record Types

​

Secure root domains

This feature allows you to create a valid SSL certificate for the root domain, in a way that it can be used either as a redirect rule to the www subdomain or as a way to show the content directly. This feature, in all cases, will create 2 new A records with Entri’s IPs to the root domain’s dns configuration, and will use Entri as proxy to encrypt and forward the traffic to your application.

IMPORTANT: This feature requires to have Entri Secure or Entri Power enabled on your account.

​

Basic usage (wwwRedirect only)

This configuration may be used for securing the root domain (e.g. https://mydomain.com) and redirect it to www (eg. https://www.mydomain.com)

{
  applicationId: "12345",
  token: mySavedToken,
  secureRootDomain: true,
  wwwRedirect:true,
  dnsRecords: [...]
}

​

Advanced usage (display content)

This configuration may be used for securing the root domain (e.g. https://mydomain.com) and show the content directly on the root domain level, without redirections.

{
  applicationId: "12345",
  token: mySavedToken,
  secureRootDomain: true,
  wwwRedirect:true,
  dnsRecords: [
    {
      type: "A",
      host: "@",
      value: "{ENTRI_SERVERS}",
      ttl: 300,
      ssl: true,
      applicationUrl: "my.applicationurl.com" // [Optional] overrides the pre-configured applicationUrl
    },
    ... //Other records
  ]
}

​

Check Domain

The checkDomain function checks the DNS configuration for a specified domain and returns details about the current DNS provider. Depending on the provided DNS records, it includes information about the registrar, supported DNS features, and, if NS records are passed, the authoritative DNS provider managing the zone file. This helps users understand the domain’s setup and feature support.

​

entri.checkDomain(domain, config)

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

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",
  {
    "applicationId": "myAppId",
    "token": "..."
    "dnsRecords": [
      {
        "host": "www",
        "ttl": 300,
        "type": "CNAME",
        "value": "cname.mydomain.com"
      },
      //... etc
    ],
    //...other optional configuration keys
  }
)

​

Check Domain as HTTP endpoint

You can also analyse the support for a domain with our http version of the checkDomain function.

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

​

Request body

{
  "domain": "ifpiggiescouldfly.com",
  "dnsRecords": [
      {
        "host": "shop",
        "type": "CNAME",
        "value": "exampledestination.com",
        "ttl": "300"
      }
    ]
}

​

Response

Please refer to CheckDomain response

​

Check Domain Response

This section describes the response structure for the API endpoint or JavaScript function that checks the DNS provider information for a given domain. Depending on the DNS records passed as parameters, the response will include details about the domain’s registrar or the authoritative DNS provider currently managing the zone file.

​

Example 1: Standard DNS Records (No NS Records)

When the request contains DNS records that are not NS (Name Server) records, the response will include information about the current DNS provider, such as the provider name, setup type, and feature support details.

Request:

{
  "applicationId": "myAppId", //Only JS function
  "token": "...", //Only JS function
  "domain": "ifpiggiescouldfly.com",
  "dnsRecords": [
    {
      "host": "shop",
      "type": "CNAME",
      "value": "exampledestination.com",
      "ttl": "300"
    }
  ]
}

Response:

{
    "provider": "GoDaddy",
    "setupType": "Automatic",
    "NSSupport": {
        "root": false,
        "subdomains": true
    },
    "wwwRedirect": false,
    "cnameFlattening": false,
    "wildcardSupport": true,
    "subdomainCnameNsOverride": true,
    "spfOverrideSupport": true,
    "expired": false
}

In this case, the authoritativeDnsProvider field is not included because NS records were not part of the request.

​

Example 2: Request with NS Records

If NS records are provided in the request, the response will also include information about the authoritative DNS provider managing the zone file.

Request:

{
  "applicationId": "myAppId", //Only JS function
  "token": "...", //Only JS function
  "domain": "ifpiggiescouldfly.com",
  "dnsRecords": [
    {
      "host": "@",
      "type": "NS",
      "value": "exampledestination.com",
      "ttl": "300"
    }
  ]
}

Response:

{
    "provider": "GoDaddy",
    "setupType": "Automatic",
    "NSSupport": {
        "root": false,
        "subdomains": true
    },
    "wwwRedirect": false,
    "cnameFlattening": false,
    "wildcardSupport": true,
    "subdomainCnameNsOverride": true,
    "authoritativeDnsProvider": {
        "provider": "GoDaddy",
        "setupType": "Automatic",
        "wwwRedirect": false,
        "cnameFlattening": false,
        "wildcardSupport": true,
        "subdomainCnameNsOverride": true
    },
    "expired": false
}

In this case, the authoritativeDnsProvider object is included because NS records were passed, providing details about the provider managing the zone file.

​

Response Parameters

• provider: The current DNS provider for the domain, either based on common DNS records or NS records if provided.
• setupType: Indicates whether automatic setup is supported for the DNS provider. If not, a manual setup flow will be presented.
• NSSupport: Object that specifies whether the provider supports nameserver configurations at the root or subdomain levels:
  • root: true if root-level nameserver configuration is supported.
  • subdomains: true if subdomain-level nameserver configuration is supported.
• wwwRedirect: Indicates whether the provider supports automatic root domain-to-www redirects.
• cnameFlattening: Specifies whether the provider supports CNAME flattening (resolving CNAMEs at the root level).
• wildcardSupport: Indicates if wildcard DNS entries (e.g., *.domain.com) are supported by the provider.
• subdomainCnameNsOverride: If true, the provider will automatically remove a CNAME record when a subdomain nameserver with the same name is added.
• expired: Boolean value indicating if the domain’s current DNS setup has expired.
• authoritativeDnsProvider (only included when NS records are provided in the request):
  • provider: The authoritative DNS provider managing the zone file.
  • setupType: Indicates if automatic or manual setup is supported for the authoritative provider.
  • wwwRedirect: Whether root domain-to-www redirects are supported by the authoritative provider.
  • cnameFlattening: Whether the authoritative provider supports CNAME flattening.
  • wildcardSupport: If the authoritative provider supports wildcard DNS entries.
  • subdomainCnameNsOverride: If the authoritative provider automatically removes CNAME records when subdomain nameserver records are added.

This response format helps users understand the current DNS configuration and determine whether the provider supports certain advanced features like wildcard records, CNAME flattening, and subdomain overrides.

​

entri.purchaseDomain(config)

This method launches the Entri Sell modal. The config object includes the same set of properties as those specified in entri.showEntri(config), plus additional Sell-specific options:

This new purchaseDomain version includes all the latest theming options, cobranded elements, and new features such as sellVersion, successCallbackUrl, and errorCallbackUrl. Make sure to set the appropriate fields to customize the flow according to your needs.

​

Asynchronous DNS configurations (Entri Sell only)

You can make asynchronous DNS configurations after the initial Entri Sell flow has finished for up to 1 hour after the initial domain purchase (Not supported on debugMode=true flows). 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:

​

entri.close()

This method will force closing the modal and also trigger the onEntriClose() event with the last step details. Please refer to the onEntriClose for more information.

​

Browser callback events

The following events are useful for following up the user’s navigation and take action under certain circumstances, for example, leading the user to your manual setup guide in case you don’t want to use Entri’s.

​

onEntriClose Callback Event

This event gets triggered as soon as the modal is closed, giving you back useful information about the latest status of the flow.

​

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",
  freeDomain: true, // Only applies to Entri Sell free domain flows
  error: { // Added to the event details if the user closed the app after an error screen.
    code: "ProviderError",
    title: "Social Login Not Supported",
    details: "You are trying to login with Social Account, please try logging in from [PROVIDER_NAME] Account"
  }
}

​

Event details object description

Errors description available at the Possible error codes section.

​

lastStatus possible values

​

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. This is useful for triggering proprietary javavascript based solutions when the user needs help with configuring the manual flow, e.g. opening support chats, etc.

​

Sample usage:

function myCustomFunction(event) {
  //Custom code here e.g. open chat app
}
window.addEventListener('onEntriManualSetupDocumentationClick', myCustomFunction, false);

​

onEntriStepChange Event

This event is triggered each time a different screen is shown within the Entri configuration process. It serves the purpose of offering additional user journey insights, making it useful for implementing listeners and triggering third-party tracking system events when necessary.

​

Sample usage:

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

​

Sample event.detail object response:

{
  domain: "example.com",
  provider: "Provider name",
  step: "ENTER_DOMAIN",
  user: "user-123456",
  error: { // Added to the event details if the user closed the app after an error screen.
    code: "ProviderError",
    title: "Social Login Not Supported",
    details: "You are trying to login with Social Account, please try logging in from [PROVIDER_NAME] Account"
  }
}

​

Event details object description

Errors description available at the Possible error codes section.

​

step possible values

​

Possible error codes

Below is a list of potential Entri modal errors. As a note, this list may not be exhaustive as some will be errors directly from the provider.

​

Webhooks

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

All webhook notifications will have the following header in the Request: "User-Agent": "Entri-Webhook".

This is the list of keys you will receive on a webhook notification:

{
  "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:

​

Token creation (JWT)

To launch the Entri modal window in a session, you’ll need to fetch a JWT using the secret key and applicationId provided by the Entri dashboard. For security reasons and in order to not expose your secret in the browser, please make sure to fetch the JWT on the server-side of your application. The JWT expires after 60 minutes. You can use any networking library you’d like. Here’s an example using javascript:

fetch('https://api.goentri.com/token', {
  method: 'POST',
  body: JSON.stringify({
    // These values come from the Entri dashboard
    applicationId: "12345",
    secret: "12345-67890"
  }),
})
.then(response => response.json())
.then(data => {
  console.log('Success:', data); // { "auth_token": "exampletoken..." }
})
.catch((error) => {
  console.error('Error:', error);
});

​

Enhancing Integration Security

To further enhance the security of your integration, you have the option to include the domain and/or dnsRecords in the JWT creation process. When these elements are added, Entri will validate them during execution, providing an additional layer of security.

POST https://api.goentri.com/token

​

Request body

{
    "applicationId": "{APPLICATION_ID}",
    "secret": "{SECRET}",
    "domain": "sampledomain.com",
    "freeDomain": true,
    "dnsRecords": [
        {
            "value": "samplevalue.com",
            "host": "@",
            "ttl": 300,
            "type": "CNAME"
        }
    ]
}

​

Parameters description

​

Successful response (200 status)

{ "auth_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...." }

​

Secure API - SSL certificates

​

Check the domain’s eligibility

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

​

Parameters description

​

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.

​

Provision an SSL certificate

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

​

Request body

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

​

Parameters description

​

Successful response (200 status)

{ "message": "Success." }

​

Possible error responses

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

​

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.

​

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.

​

Power API - Custom domains

​

Check the domain’s eligibility

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

​

Parameters description

​

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.

​

Power a new domain

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

​

Request body

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

​

Successful response (200 status)

{ "message": "Success." }

​

Possible error responses

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

​

Update an already powered domain

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

​

Request body

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

​

Successful response (200 status)

{ "message": "Success." }

​

Possible error responses

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

​

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.

​

Sharing links API

​

Entri Connect

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

​

Request body

{
   "applicationId":"yourApplicationID",
   "config":{
      "prefilledDomain": "mydomain.com",
      "dnsRecords":[
         {
            "type":"CNAME",
            "host":"www",
            "value":"test.com",
            "ttl":300
         }
      ]
   }
}
//All the rest of possible configuration options, see https://developers.entri.com/api-reference#entrishowentriconfig for more details.

​

Successful response (200 status)

{
    "link": "https://app.goentri.com/share/dd339cf05f2646539e79251f8e62f0c5",
    "job_id": "9c128fe4-63cd-4ec4-9ae8-8a9d06c0e6de"
}

​

Entri Sell

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

​

Request body

{
   "applicationId":"yourApplicationID",
   "config":{
      "prefilledDomain": "mydomain.com",
      "dnsRecords":[
         {
            "type":"CNAME",
            "host":"www",
            "value":"test.com",
            "ttl":300
         }
      ]
   }
}
  //All the rest of possible configuration options, see https://developers.entri.com/api-reference#entrishowentriconfig for more details.

​

Provider Health

Returns the status of all the providers for an application ID that Entri supports.

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

​

Response body

{
  "message": "success",
  "data": [
    {
      "provider": "IONOS",
      "enabled": true
    },
    {
      "provider": "Enom",
      "enabled": true
    },
    {
      "provider": "Amazon Route 53",
      "enabled": true
    },
    ...
  ]
}