entri.showEntri(config)

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

dnsRecords object

DNS records can have the following properties:

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.

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

Possible flow results

This is the complete list of errors we have identified so far. It includes the most common errors we’ve seen from the user and prompts them with a corresponding message for action to resolve. As a note, this list may not be exhaustive as some will be errors directly from the provider.

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

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:

Browser events

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",
  freeDomain: true // Only applies to Entri Sell free domain flows
}

Event details object description

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

Event details object description

step possible values

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:

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",
  /*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.

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.

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",
  "domain": "www.example.com",
  "dnsRecords": {
    "type": "cname",
    "host": "@",
    "value": "www",
    "ttl": 1800
  },
  //All the rest of possible configuration options, see https://developers.entri.com/docs/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",
  "domain": "www.example.com",
  "dnsRecords": {
    "type": "cname",
    "host": "@",
    "value": "www",
    "ttl": 1800
  },
  //All the rest of possible configuration options, see https://developers.entri.com/docs/api-reference#entrishowentriconfig for more details.
}