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 '
{
  "url": "https://example.com",
  "active": true
}
'
import requests

url = "https://api.dev.name.com/core/v1/notifications"

payload = {
"url": "https://example.com",
"active": True
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({url: 'https://example.com', active: true})
};

fetch('https://api.dev.name.com/core/v1/notifications', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.dev.name.com/core/v1/notifications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => 'https://example.com',
'active' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.dev.name.com/core/v1/notifications"

payload := strings.NewReader("{\n \"url\": \"https://example.com\",\n \"active\": true\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.dev.name.com/core/v1/notifications")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://example.com\",\n \"active\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.dev.name.com/core/v1/notifications")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://example.com\",\n \"active\": true\n}"

response = http.request(request)
puts response.read_body
{
  "subscription": {
    "active": true,
    "createDate": "<string>",
    "eventName": "<string>",
    "id": 123,
    "updateDate": "<string>",
    "url": "<string>"
  }
}
{
"message": "Bad Request",
"details": "'domainName' cannot be null"
}
{
"message": "Unauthorized"
}
{
"message": "Permission denied",
"details": "Failed authentication"
}
{
"message": "Method Not Allowed"
}
{
"message": "Conflict",
"details": "You are attempting to subscribe to an event you have already subscribed to."
}
{
"message": "The 'Content-Type' header must be 'application/json' for this request."
}
{
"message": "Rate Limit Exceeded"
}
{
"message": "Internal Server Error",
"details": "Something went wrong."
}
{
"message": "The server received an invalid response from the upstream server."
}
{
"message": "The upstream server is taking too long to respond."
}

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,
domain.transfer_out.status_change,
contact.verification.status_change,
domain.transfer.internal_in,
domain.registry.rejection
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