Skip to main content
POST
Subscribe to Notification

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.transfer.internal_out,
domain.registry.rejection,
domain.expiration
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