Skip to main content
WEBHOOK
domainLockStatusChange
{
  "eventName": "domain.lock.status_change",
  "domainName": "example.org",
  "action": "added",
  "lockType": "ClientHold",
  "registryStatuses": [
    "clientHold",
    "clientTransferProhibited",
    "clientUpdateProhibited"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.name.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Authenticate via HTTP Basic with your account username and API token. Examples use an explicit 'Authorization: Basic <base64(username:token)>' header; 'curl -u username:token' is equivalent. For sandbox, append "-test" to your username and use your sandbox token on api.dev.name.com.

Headers

​
X-NAMECOM-SIGNATURE
string
required

HMAC signature for the request payload. See HMAC signing documentation for example code and detailed explanation of signing.

Example:

"djasfgafgflgsdfgdsfkhfhjas,12334782,1123-3423-4dss4-354"

Body

application/json
​
eventName
enum<string>
required
Available options:
domain.lock.status_change
​
domainName
string
required

Fully-qualified domain name

Example:

"example.org"

​
action
enum<string>
required
Available options:
added,
removed
​
lockType
enum<string>
required

The lock type affected by this event (added or removed)

Available options:
RegistrarLock,
TransferLock,
AccountLock,
ClientHold,
VerificationClientHold,
VerificationHold,
PrivacyLock,
ExpirationClientHold
​
registryStatuses
string[]
required

Current registry statuses after the change

Example:
[
  "clientHold",
  "clientTransferProhibited",
  "clientUpdateProhibited"
]

Response

The subscribed server accepted the request.