API
SubscribeToNotification
Subscribe to a specific notification
Endpoint: POST /v4/notifications
Parameters:
eventName
string
* The name of the event you are subscribing to. Notification events are predefined and validated. If there is an notification that you would like to see added to our list of available notifications, please contact our support team Current notification events: domain.transfer.status_change account.credit.balance_change
url
string
The URL we will send a POST request to with the notification message
active
bool
Whether or not the subscription is active
Response:
Example:
curl -u 'username:token' 'https://api.dev.name.com/v4/notifications' -X POST -H 'Content-Type: application/json' --data '{"eventName":"domain.transfer.status_change","url":"https:\/\/example.com\/incomingnotification","active":true}'
{
"subscription": {
"id": 1,
"eventName": "domain.transfer.status_change",
"url": "https://example.com/incomingnotification",
"active": true,
"createDate": "2025-02-17T22:58:35Z",
"updateDate": "2025-02-17T22:58:35Z"
}
}
Example:
curl -u 'username:token' 'https://api.dev.name.com/v4/notifications'
{
"subscriptions": [
{
"id": 1,
"eventName": "domain.transfer.status_change",
"url": "https://example.com/incomingnotification",
"active": true,
"createDate": "2025-02-17T22:58:35Z",
"updateDate": "2025-02-17T22:58:35Z"
}
]
}
Example:
curl -u 'username:token' 'https://api.dev.name.com/v4/notifications/12345' -X PUT -H 'Content-Type: application/json' --data '{"url":"https:\/\/example.com\/incomingnotification","active":true}'
{
"subscription": {
"id": 1,
"eventName": "domain.transfer.status_change",
"url": "https://example.com/incomingnotification",
"active": true,
"createDate": "2025-02-17T22:58:35Z",
"updateDate": "2025-02-17T22:58:35Z"
}
}
DeleteSubscription
* Delete a subscription by it's ID. No response body will be returned by by this request. We will just return a 200 Success response, with no response body
Endpoint: DELETE /v4/notifications/{id}
Parameters:
id
(path parameters)
int32
ID of the subscription to delete
Response:
Empty response.
Example:
curl -u 'username:token' 'https://api.dev.name.com/v4/notifications/12345' -X DELETE
{}