Webhook Notifications
/
Webhook for credit balance changes

Name.com Core API (1.0.1)

RESTful API for managing domains, DNS records, and related services at Name.com. Access via HTTPS at api.name.com (production) or api.dev.name.com (testing). Supports standard authentication, rate-limited to 20 requests/second.

Download OpenAPI description
namecom.api.json
namecom.api.yaml
Overview
Account Services

accountservices@name.com

Terms of Service

Languages
Servers
Mock server

https://docs.name.com/_mock/coreapi/namecom.api/

Testing

https://api.dev.name.com/

Hello

Use the Hello endpoint to verify that your API connection and credentials are working properly. This simple call returns a success message (along with server time and version info) to confirm the API is reachable and authenticated.

Operations

Account Info

Use Account Info endpoints to retrieve basic information about your Name.com account. For example, you can check your account’s current credit balance and other account details using these endpoints.

Operations

Accounts

Use Accounts endpoints (available upon request) to manage sub-accounts under your main account. For example, resellers can programmatically create new customer accounts with their own login credentials and permissions.

Operations

Domains

Use Domains endpoints to search for domain availability, register new domains, and manage existing domains.

Operations

DNS

Use DNS endpoints to manage DNS records for your domains. You can list all existing DNS records for a domain and create, update, or delete records as needed.

Operations

DNSSECs

Use DNSSEC endpoints to configure DNS Security Extensions for your domains. These endpoints allow you to add, retrieve, or remove DNSSEC records.

Operations

Email Forwardings

Use Email Forwardings endpoints to set up and manage email forwarding addresses on your domains.

Operations

URL Forwardings

Use URL Forwardings endpoints to control URL redirection settings for your domains.

Operations

Vanity Nameservers

Use Vanity Nameservers endpoints to configure custom nameserver hostnames (glue records) for your domains.

Operations

Transfers

Use Transfers endpoints to move domains into your Name.com account. Start by creating a transfer request, then monitor and manage the status of pending transfers. You can also cancel a transfer if needed.

Operations

Orders

Use Orders endpoints to review and track purchases made via the API.

Operations

Webhook Notifications

Use Webhook Notification endpoints to subscribe to real-time notifications for account and domain events. This keeps your application updated on important changes without polling the API.

OperationsWebhooks

Get Subscribed Notifications

Request

Retrieves all active webhook subscriptions on the account.

curl -i -X GET \
  -u <username>:<password> \
  https://docs.name.com/_mock/coreapi/namecom.api/core/v1/notifications

Responses

A successful response.

Bodyapplication/json
subscriptionsArray of objects(SubscriptionRecord)
Response
application/json
{
  "subscriptions": [
    { … }
  ]
}

Subscribe To Notification

Request

Creates a webhook subscription to receive real-time notifications about specific domain or account events (e.g. transfer completions, renewals). Pass the callback URL and event types. This allows external systems to stay in sync with Name.com changes.

Bodyapplication/json
eventNamestring(AvailableWebhooks)required

The list of configured webhooks you can subscribe to

Enum"domain.transfer.status_change""account.credit.balance_change"
urlstringrequired

The URL we will send the notification data to

Example: "https://example.com"
activebooleanrequired

If the webhook should be active. This allows a webhook to be deactivated in our system. It may be useful to deactivate a webhook if the server that receives the POST request is undergoing scheduled maintenance, for example.

curl -i -X POST \
  -u <username>:<password> \
  https://docs.name.com/_mock/coreapi/namecom.api/core/v1/notifications \
  -H 'Content-Type: application/json' \
  -d '{
    "eventName": "domain.transfer.status_change",
    "url": "https://example.com",
    "active": true
  }'

Responses

A successful response.

Bodyapplication/json
subscriptionobject(SubscriptionRecord)
Response
application/json
{
  "subscription": {
    "active": true,
    "createDate": "string",
    "eventName": "string",
    "id": 0,
    "updateDate": "string",
    "url": "string"
  }
}

Delete Subscription

Request

Removes a webhook subscription from the account.

Path
idinteger(int32)required

ID of the subscription to delete.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://docs.name.com/_mock/coreapi/namecom.api/core/v1/notifications/{id}'

Responses

Subscription successfully deleted.

Response
No content

Modify Subscription

Request

Updates an existing webhook’s configuration. This may include changing the callback URL or updating whether the webhook is currently active.

Path
idinteger(int32)required

ID of the subscription to update.

Bodyapplication/json
Any of:
urlstringrequired

Optionally update the URL we send the webhook data to

Example: "https://example2.com"
activeboolean

Optionally update if the subscription is currently active

Example: false
curl -i -X PUT \
  -u <username>:<password> \
  'https://docs.name.com/_mock/coreapi/namecom.api/core/v1/notifications/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "https://example2.com",
    "active": false
  }'

Responses

A successful response.

Bodyapplication/json
subscriptionobject(SubscriptionRecord)
Response
application/json
{
  "subscription": {
    "active": true,
    "createDate": "string",
    "eventName": "string",
    "id": 0,
    "updateDate": "string",
    "url": "string"
  }
}

Domain Transfer Status ChangeWebhook

Request

Sent when you have subscribed to the event on your account, and a domain transfer is processing.

Bodyapplication/jsonrequired

The request sent to your server.

eventNamestringrequired

The name of the subscription event

domainNamestringrequired

The domain that the transfer status has changed for

statusstring

The updated status of the domain transfer

application/json
{
  "eventName": "string",
  "domainName": "string",
  "status": "string"
}

Responses

The subscribed server accepted the request.

Webhook for credit balance changesWebhook

Request

This is the payload that will be sent to the subscribed URL, when a changed to the amount of account credit for an account changes. This will trigger on both increases and decreases in account credit for the account.

Bodyapplication/jsonrequired
eventNamestring

The name of the subscription event

accountIdnumber(int64)

The account ID the subscription is for

balancenumber(double)

The remaining balance of account credit

application/json
{
  "eventName": "string",
  "accountId": 0,
  "balance": 0.1
}

Responses

The subscribed server accepted the request.