Connect Events

​

Webhook event types

• "domain.added": Indicates that DNS records have been successfully added.
  • For Entri Sell, this means the domain has been registered and connected.
  • For Entri Connect, it confirms that DNS records have been added to an existing domain.
  • Multiple messages of this type may be received for the same domain. This occurs when either the propagation_status or redirection_status changes.
• "domain.propagation.timeout": This event is very rare and is triggered if DNS records fail to propagate after 72 hours. It is highly uncommon for domains connected through the automatic flow.
• "domain.flow.completed": Indicates that the user has completed the Entri domain connection flow. This event does not convey any propagation status — it only confirms that the user finished the flow steps.

​

Status fields

• propagation_status: The status of DNS record propagation. Possible values:
  • "pending": DNS records are still being propagated.
  • "success": DNS records have been successfully propagated.
  • "failed": DNS record propagation has failed. This is triggered if the records are not propagated even after 72 hours.
  • "exempt": Only present in notifications with type:"purchase.confirmation.expired".
• dkim_status: The status of DKIM (DomainKeys Identified Mail) configuration. Possible values:
  • "pending": DKIM setup is pending.
  • "success": DKIM configuration has been successfully completed.
  • "failed": DKIM setup failed.
  • "exempt": DKIM setup is exempt, usually if the user does not use a supported email provider (e.g. Google or Microsoft).
• redirection_status: The status of domain redirection. Possible values:
  • "pending": Redirection setup is in progress.
  • "success": Redirection setup has completed successfully.
  • "failed": Redirection setup failed.
  • "exempt": Redirection is exempt from this setup.
• setup_type: Indicates whether the setup was done automatically or manually. Possible values:
  • "automatic": Setup was performed automatically.
  • "manual": Setup required manual intervention.
  • "async": Setup was done using the DNS asynchronous update.
  • "api": The setup was performed using the Entri Sell Enterprise API

​

Advanced DMARC configuration feature

• dmarc_updated: Reflects the status of DMARC (Domain-based Message Authentication, Reporting, and Conformance) updates. Possible values:
  • "true": DMARC settings have been updated.
  • "false": DMARC settings were not updated.
  • "exempt": DMARC is not applicable in this situation (e.g. for domains that don’t require it).

​

Data object (DNS records)

• records_propagated: An array of DNS records that have been successfully propagated. Each record contains:
  • type: The type of DNS record (e.g. "A", "CNAME").
  • host: The hostname for which the DNS record applies (e.g. "smallbusiness.com").
  • value: The value of the DNS record (e.g. "54.153.2.220").
  • applicationUrl: (optional, Entri Power only) The application URL tied to the propagated DNS record (e.g. "www.example.com").
  • powerRootPathAccess: (optional, Entri Power only) An array of paths accessible through Entri Power. Example:
    ["path1", "path2", "pathN"]
    
• records_non_propagated: An array of DNS records that have not yet propagated. The structure is the same as records_propagated.

​

Shared flows

​

Frontend event: onSharedFlowSent

• the sharedFlowId (originating / shared flow)
• the derived flow run that completes later (via origin_flow_id in webhooks)

entri.purchaseDomain({
  // ...
  onSharedFlowSent: ({ sharedFlowId }) => {
    // Persist sharedFlowId to correlate with webhook origin_flow_id
  }
})

​

Browser callback events

​

onSuccess Callback Event

​

Sample usage:

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

​

Sample event.detail object response:

{
  "domain": "example.com",
  "success": true,
  "setupType": "automatic",
  "provider": "Provider name",
  "freeDomain": true,
  "jobId": "2132b20f-e522-42fc-9604-5a53b1f13a4b"
}

​

Event details object description

​

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

​

lastStatus possible values

​

onEntriManualSetupDocumentationClick Event

​

Sample usage:

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

​

onEntriStepChange Event

​

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

​

step possible values

​

onEntriRequestClose Event

​

Sample usage:

function handleRequestClose(event) {
  console.log('onEntriRequestClose', event.detail);
  // Show your own confirmation UI here.
  // If the user confirms exit, call entri.close():
  // entri.close();
}
window.addEventListener('onEntriRequestClose', handleRequestClose, false);

​

event.detail payload

​

Possible error codes