Skip to main content
POST
Create webhook
By default, an organization is limited to have 5 webhooks per group.
If you need more webhooks, feel free to contact us and explain your needs, and we’ll update your limits accordingly

Authorizations

X-Api-Key
string
header
required

API key used to authenticate yourself on DNSRadar. Obtain your API key from your DNSRadar dashboard.

Body

application/json
url
string<uri>
required

Webhook endpoint URL (must not resolve to private/loopback IPs)

Maximum string length: 2000
method
enum<string>
default:POST
required
Available options:
POST,
PUT,
DELETE,
PATCH
headers
object

Custom HTTP headers

secret
string

Secret key for HMAC-SHA256 signing of webhook requests

Example:

"Ultra Secure P@ssw0rd!"

groups
string[]

Array of group identifiers (slug or UUID). Accepts either group slugs or UUIDs (with 'grp_' prefix). If a slug is provided and doesn't exist, a new group will be automatically created with that slug.

Example:

Response

Webhook created

Webhook configuration for event notifications

id
string

Webhook identifier with 'whk_' prefix

Example:

"whk_abc123..."

created
string<date-time>

Webhook creation datetime in ISO 8601 format

url
string<uri>

Webhook endpoint URL

Example:

"https://api.server.com/webhook/dnsradar"

method
enum<string>
default:POST

HTTP method to use for the webhook

Available options:
POST,
PUT,
DELETE,
PATCH
headers
object | null

Custom HTTP headers as key-value pairs

Example:
secret
string | null

Secret key used for HMAC-SHA256 signing of webhook requests. The signature is sent in the X-Webhook-Signature header.

Example:

"Ultra Secure P@ssw0rd!"

is_active
boolean

Whether webhook is active

last_error
string | null

Last error message if any

Example:

"Timeout connecting to endpoint"

last_executed
string<date-time> | null

Datetime of last execution in ISO 8601 format

groups
string[]

List of group UUIDs associated with this webhook

Group UUID with 'grp_' prefix

Example: