Sell Events

​

Webhook event types

• "domain.purchased": Indicates that the domain order creation has been completed.
• "domain.registered": The registrar has registered a purchased domain. Sent once per domain, whether or not disableConnect is set. See Registration events.
• "domain.registration_timeout": Entri could not confirm the registration of a purchased domain within 48 hours of the purchase. Sent once per domain. See Registration events.
• "domain.purchase.dns_setup.failed": The registrar rejected the DNS records Entri tried to set up for a purchased domain. Sent once per domain. See DNS setup failure.
• "domain.transfer.in.initiated": Only applicable for Entri Sell Enterprise. An inbound domain transfer has been initiated by the user.
• "domain.transfer.in.started": Only applicable for Entri Sell Enterprise. The inbound domain transfer has been accepted and is now in progress at the registry level.
• "domain.transfer.in.ack": Only applicable for Entri Sell Enterprise. The inbound domain transfer has been acknowledged by the registry.
• "domain.transfer.in.failed": Only applicable for Entri Sell Enterprise. The inbound domain transfer has failed.
• "domain.transfer.out.initiated": Only applicable for Entri Sell Enterprise. An outbound domain transfer away from Entri has been initiated.
• "purchase.error": Indicates an error during the domain purchase process.
• "purchase.user_aborted": Only applicable for IONOS. The user closed the IONOS checkout. This can happen after the purchase already completed, so if you also received domain.purchased for the same domain, the domain was purchased. Carries the same payload as purchase.error.
• "purchase.confirmation.expired": The purchase confirmation has expired (abandoned flow).

​

Registration events

​

Event sequence

1. domain.purchased: once per order. purchased_domains lists every domain in the order.
2. domain.registered: once per purchased domain, as soon as Entri confirms that the domain is registered and resolving in DNS. This is usually within minutes, and can take longer while the registrar reviews the order.
3. domain.added: once per purchased domain, after Entri applies the DNS records from your configuration. See Connect events.

​

Registration timeout

​

Receiving registration events

​

Sample payload

{
  "id": "0b8a6b8e-2a4f-5d7e-9c3a-6f1e2d4c5b7a",
  "type": "domain.registered",
  "domain": "example.com",
  "subdomain": "www",
  "user_id": "your-provided-user-id",
  "provider": "ionos",
  "setup_type": "automatic",
  "purchased_domains": ["example.com"],
  "propagation_status": "exempt",
  "dkim_status": "exempt",
  "secure_status": "exempt",
  "power_status": "exempt",
  "dmarc_updated": "exempt",
  "redirection_status": "exempt",
  "data": {
    "records_propagated": [],
    "records_non_propagated": []
  }
}

​

DNS setup failure

​

Payload fields

• purchased_domains: An array of domains that were purchased during the transaction. This field is only relevant for Entri Sell. Example:
  ["domain1.com", "domain2.com", "domainN.com"]
  
• free_domain: Indicates whether the domain was obtained through a free domain flow. Possible values:
  • true: The domain was free.
  • false: The domain was not free.

​

Status fields

• secure_status: The status of SSL certificate provisioning through Entri Secure. Possible values:
  • "pending": The DNS records required by Entri Secure have not propagated yet, so the certificate has not been issued.
  • "success": The records propagated and the SSL certificate was provisioned.
  • "failed": The records did not propagate within 72 hours. Sent together with the domain.propagation.timeout event.
  • "exempt": Entri Secure is not enabled for the application or does not apply to this flow. This is always the value on purchase.error and purchase.confirmation.expired events.
• power_status: The status of the advanced features configuration through Entri Power. Possible values:
  • "pending": The DNS records required by Entri Power have not propagated yet.
  • "success": The records propagated and Entri Power is configured for the domain.
  • "failed": The records did not propagate within 72 hours. Sent together with the domain.propagation.timeout event.
  • "exempt": Entri Power is not enabled for the application or does not apply to this flow. This is always the value on purchase.error and purchase.confirmation.expired events.
• monitor_status: The status of the domain’s enrollment in Entri Monitor. Only present when the flow has records to monitor, which happens when the monitor config option is true and Monitor is enabled for your account. Unlike secure_status and power_status, this field is never "exempt": it is simply omitted from the payload when Monitor does not apply. Possible values:
  • "pending": The monitored records have not propagated yet, so the domain is not enrolled in Monitor.
  • "success": The records propagated and the domain is now monitored.
  • "failed": The records did not propagate within 72 hours. Sent together with the domain.propagation.timeout event.

​

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": "purchase",
  "provider": "squarespace",
  "freeDomain": false,
  "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,
  "lastStatus": "FINISHED_SUCCESSFULLY",
  "provider": "squarespace",
  "setupType": "purchase"
}

​

Event details object description