Skip to main content
POST
/
core
/
v1
/
notifications
Subscribe To Notification
curl --request POST \
  --url https://api.dev.name.com/core/v1/notifications \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "eventName": "account.credit.balance_change",
  "url": "https://example.com",
  "active": true
}
'
{
  "subscription": {
    "active": true,
    "createDate": "<string>",
    "eventName": "<string>",
    "id": 123,
    "updateDate": "<string>",
    "url": "<string>"
  }
}

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.

Body

application/json

Request to subscribe to a specific webhook notification

​
eventName
enum<string>
required

The list of configured webhooks you can subscribe to

Available options:
account.credit.balance_change,
domain.lock.status_change,
domain.transfer.status_change
​
url
string
required

The URL we will send the notification data to

Example:

"https://example.com"

​
active
boolean
required

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.

Response

A successful response.

​
subscription
* The record for each notification you have subscribed to · object