Events Endpoints
GET /events returns a timestamped history of a reseller's orders, subscriptions and resold products, including status changes.
Events are the only way to learn about changes to subscriptions initiated outside of the reseller API -- i.e. by Squarespace. Polling /events is strongly recommended for resellers to stay updated on the status resold products, so they can keep their billing processes in sync -- e.g. discontinue billing if the customer has transferred their domain away from Squarespace.
Note that for all domain events, Squarespace acts as the registrar and emails the customer directly (e.g. regarding transfer, suspensions). Resellers can refer customers to Squarespace for any non-billing, product related questions.
Event webhooks are a planned feature for the reseller API. Until they are released, polling /events is the mechanism for resellers to stay in sync with Squarespace-side changes.
What's possible
✅ Get the history of reseller orders, product, or subscription
What's not possible
✖️ Get details about a customer — use Customers instead
Events Reference
Order events
| Detail | Description | Status from | Status to | Notes |
|---|---|---|---|---|
RECEIVED | Acknowledges that the order was received by the Reseller API. | — | PENDING | New order in PENDING state. |
PROCESSED | The order completed successfully. | PENDING | COMPLETE | |
UPDATED | Partial order failure. Message format: Failed to process order item {orderItemId}: {failure reason} | — | — | Some items in the order succeeded; others did not. |
FAILED | The order failed. | PENDING | FAILED |
Polling for order status
Order processing is asynchronous. A successful POST /orders always returns PENDING; observed times for an order status to update to COMPLETE: p50 = 12s, p95 = 26s, p99 = 45s.
We recommend the following polling strategy against /events or GET /orders/{orderId}:
- Every 10 seconds for the first 5 minutes
- Every 1 minute for the following 72 hours
- Treat as failed after 72 hours
Domain events
| Detail | Message values | Description | Status from | Status to |
|---|---|---|---|---|
CREATED | • New registration • Transferred • Reactivated • Imported • Migrated • Unknown | A domain was created by registration, transfer completion, redemption, back-end import or reactivation. New registration is the default for the Reseller API. | — | ACTIVE |
DELETED | • Transferred (out) • Cancelled by Registrar • Cancelled by Reseller • Deleted by Reseller • Expired (30 days after expiration) • Unknown | The domain was removed from your reseller service, with the reason. | — | — |
SUSPENDED | • Suspended by Registry • Suspended due to Dispute • Suspended due to Legal • Suspended due to Abuse • Suspended due to Poor Data Quality • Registrant Verification Failed | The domain was suspended, with the reason. | — | SUSPENDED |
UNSUSPENDED | • Registry / Dispute / Legal / Abuse / Poor Data Quality suspension removed • Registrant Verification Completed | The suspension was lifted. | SUSPENDED | ACTIVE |
EXPIRED | • Expired | The domain expired without a renewal being triggered. | ACTIVE | EXPIRED |
UPDATED | • Domain settings for whois-privacy / nameservers / dns / locking / contacts / zone check updated• Domain registrant verification completed | Any change to domain settings. | ACTIVE | ACTIVE |
RENEWED | • Auto renewal or manual renewal • Reactivation (auto-renew off, reactivated after expiry) | The domain was renewed. | ACTIVE | ACTIVE |
Website events
| Detail | Message values | Description |
|---|---|---|
CREATED | • New subscription • Reactivated | A resold website was created, either new or reactivated after cancellation or expiration. |
DELETED | — | The website was removed. |
UPDATED | • Connected to Domain {domainName}• Disconnected from Domain {domainName}• Website was published • Website was unpublished | Domain connection changes are only reported when the domain is available to the website owner. |
Subscription events
| Detail | Message values | Description | Status from | Status to |
|---|---|---|---|---|
CREATED | — | A subscription was created. | — | — |
RENEWED | • Auto renewal or manual renewal • Reactivation | The subscription was renewed. | ACTIVE | ACTIVE |
UPDATED | • Subscription auto-renew updated | Auto-renew was turned on or off. | — | — |
DELETED | • Cancelled by Reseller • Refunded by Reseller • Product Deleted | Acknowledges a subscription cancellation. | ACTIVE | CANCELLED |
EXPIRED | — | The subscription expired. | ACTIVE or CANCELLED | EXPIRED |