Chief Tools Logo
Domain Chief API v1

Requests sent to your webhook endpoints when something happens. Each page shows the headers and body of the request, and the response your endpoint should give.


domain.changed

POSTyour webhook endpointWebhook

A domain changed and should be retrieved again.

domain.changed › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.changed › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain changed and should be retrieved again.

Enum values:
domain.changed
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.changed › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

contact.created

POSTyour webhook endpointWebhook

A contact was created.

contact.created › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

contact.created › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A contact was created.

Enum values:
contact.created
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

contact.created › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

contact.changed

POSTyour webhook endpointWebhook

A contact changed and should be retrieved again.

contact.changed › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

contact.changed › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A contact changed and should be retrieved again.

Enum values:
contact.changed
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

contact.changed › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

contact.deleted

POSTyour webhook endpointWebhook

A contact was deleted.

contact.deleted › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

contact.deleted › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A contact was deleted.

Enum values:
contact.deleted
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

contact.deleted › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

dns_record.created

POSTyour webhook endpointWebhook

A DNS record was created.

dns_record.created › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

dns_record.created › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A DNS record was created.

Enum values:
dns_record.created
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

dns_record.created › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

dns_record.changed

POSTyour webhook endpointWebhook

A DNS record changed and should be retrieved again.

dns_record.changed › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

dns_record.changed › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A DNS record changed and should be retrieved again.

Enum values:
dns_record.changed
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

dns_record.changed › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

dns_record.deleted

POSTyour webhook endpointWebhook

A DNS record was deleted.

dns_record.deleted › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

dns_record.deleted › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A DNS record was deleted.

Enum values:
dns_record.deleted
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

dns_record.deleted › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

web_redirect.created

POSTyour webhook endpointWebhook

A web redirect was created.

web_redirect.created › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

web_redirect.created › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A web redirect was created.

Enum values:
web_redirect.created
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

web_redirect.created › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

web_redirect.changed

POSTyour webhook endpointWebhook

A web redirect changed and should be retrieved again.

web_redirect.changed › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

web_redirect.changed › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A web redirect changed and should be retrieved again.

Enum values:
web_redirect.changed
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

web_redirect.changed › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

web_redirect.deleted

POSTyour webhook endpointWebhook

A web redirect was deleted.

web_redirect.deleted › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

web_redirect.deleted › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A web redirect was deleted.

Enum values:
web_redirect.deleted
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

web_redirect.deleted › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

mail_forward.created

POSTyour webhook endpointWebhook

A mail forward was created.

mail_forward.created › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

mail_forward.created › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A mail forward was created.

Enum values:
mail_forward.created
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

mail_forward.created › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

mail_forward.changed

POSTyour webhook endpointWebhook

A mail forward changed and should be retrieved again.

mail_forward.changed › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

mail_forward.changed › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A mail forward changed and should be retrieved again.

Enum values:
mail_forward.changed
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

mail_forward.changed › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

mail_forward.deleted

POSTyour webhook endpointWebhook

A mail forward was deleted.

mail_forward.deleted › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

mail_forward.deleted › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A mail forward was deleted.

Enum values:
mail_forward.deleted
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

mail_forward.deleted › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.registration.requested

POSTyour webhook endpointWebhook

A domain registration was requested.

domain.registration.requested › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.registration.requested › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain registration was requested.

Enum values:
domain.registration.requested
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.registration.requested › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.registration.request_cancelled

POSTyour webhook endpointWebhook

A pending domain registration was cancelled.

domain.registration.request_cancelled › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.registration.request_cancelled › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A pending domain registration was cancelled.

Enum values:
domain.registration.request_cancelled
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.registration.request_cancelled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.registration.succeeded

POSTyour webhook endpointWebhook

A domain was registered.

domain.registration.succeeded › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.registration.succeeded › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain was registered.

Enum values:
domain.registration.succeeded
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.registration.succeeded › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.registration.failed

POSTyour webhook endpointWebhook

A domain registration failed.

domain.registration.failed › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.registration.failed › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain registration failed.

Enum values:
domain.registration.failed
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.registration.failed › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.registration.retry_requested

POSTyour webhook endpointWebhook

A failed domain registration is retried.

domain.registration.retry_requested › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.registration.retry_requested › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A failed domain registration is retried.

Enum values:
domain.registration.retry_requested
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.registration.retry_requested › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.transfer.incoming.requested

POSTyour webhook endpointWebhook

An incoming domain transfer was requested.

domain.transfer.incoming.requested › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.transfer.incoming.requested › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

An incoming domain transfer was requested.

Enum values:
domain.transfer.incoming.requested
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.transfer.incoming.requested › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.transfer.incoming.request_cancelled

POSTyour webhook endpointWebhook

A pending incoming transfer was cancelled.

domain.transfer.incoming.request_cancelled › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.transfer.incoming.request_cancelled › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A pending incoming transfer was cancelled.

Enum values:
domain.transfer.incoming.request_cancelled
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.transfer.incoming.request_cancelled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.transfer.incoming.succeeded

POSTyour webhook endpointWebhook

A domain was transferred in.

domain.transfer.incoming.succeeded › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.transfer.incoming.succeeded › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain was transferred in.

Enum values:
domain.transfer.incoming.succeeded
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.transfer.incoming.succeeded › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.transfer.incoming.failed

POSTyour webhook endpointWebhook

An incoming domain transfer failed.

domain.transfer.incoming.failed › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.transfer.incoming.failed › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

An incoming domain transfer failed.

Enum values:
domain.transfer.incoming.failed
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.transfer.incoming.failed › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.transfer.incoming.retry_requested

POSTyour webhook endpointWebhook

A failed incoming transfer is retried.

domain.transfer.incoming.retry_requested › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.transfer.incoming.retry_requested › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A failed incoming transfer is retried.

Enum values:
domain.transfer.incoming.retry_requested
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.transfer.incoming.retry_requested › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.transfer.incoming.scheduled

POSTyour webhook endpointWebhook

An incoming transfer was scheduled.

domain.transfer.incoming.scheduled › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.transfer.incoming.scheduled › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

An incoming transfer was scheduled.

Enum values:
domain.transfer.incoming.scheduled
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.transfer.incoming.scheduled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.transfer.incoming.schedule_moved

POSTyour webhook endpointWebhook

A scheduled incoming transfer was moved.

domain.transfer.incoming.schedule_moved › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.transfer.incoming.schedule_moved › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A scheduled incoming transfer was moved.

Enum values:
domain.transfer.incoming.schedule_moved
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.transfer.incoming.schedule_moved › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.transfer.incoming.schedule_cancelled

POSTyour webhook endpointWebhook

A scheduled incoming transfer was cancelled.

domain.transfer.incoming.schedule_cancelled › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.transfer.incoming.schedule_cancelled › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A scheduled incoming transfer was cancelled.

Enum values:
domain.transfer.incoming.schedule_cancelled
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.transfer.incoming.schedule_cancelled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.transfer.outgoing.requested

POSTyour webhook endpointWebhook

Another registrar requested to transfer a domain out.

domain.transfer.outgoing.requested › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.transfer.outgoing.requested › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

Another registrar requested to transfer a domain out.

Enum values:
domain.transfer.outgoing.requested
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.transfer.outgoing.requested › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.transfer.outgoing.succeeded

POSTyour webhook endpointWebhook

A domain was transferred to another registrar.

domain.transfer.outgoing.succeeded › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.transfer.outgoing.succeeded › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain was transferred to another registrar.

Enum values:
domain.transfer.outgoing.succeeded
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.transfer.outgoing.succeeded › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.transfer.outgoing.accepted

POSTyour webhook endpointWebhook

An outgoing transfer was accepted.

domain.transfer.outgoing.accepted › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.transfer.outgoing.accepted › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

An outgoing transfer was accepted.

Enum values:
domain.transfer.outgoing.accepted
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.transfer.outgoing.accepted › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.transfer.outgoing.rejected

POSTyour webhook endpointWebhook

An outgoing transfer was rejected.

domain.transfer.outgoing.rejected › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.transfer.outgoing.rejected › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

An outgoing transfer was rejected.

Enum values:
domain.transfer.outgoing.rejected
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.transfer.outgoing.rejected › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.transfer.outgoing.cancelled

POSTyour webhook endpointWebhook

An outgoing transfer was cancelled.

domain.transfer.outgoing.cancelled › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.transfer.outgoing.cancelled › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

An outgoing transfer was cancelled.

Enum values:
domain.transfer.outgoing.cancelled
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.transfer.outgoing.cancelled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.transfer.push.requested

POSTyour webhook endpointWebhook

A push transfer to another registrar was requested.

domain.transfer.push.requested › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.transfer.push.requested › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A push transfer to another registrar was requested.

Enum values:
domain.transfer.push.requested
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.transfer.push.requested › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.transfer.push.failed

POSTyour webhook endpointWebhook

A push transfer failed at the registry.

domain.transfer.push.failed › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.transfer.push.failed › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A push transfer failed at the registry.

Enum values:
domain.transfer.push.failed
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.transfer.push.failed › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.transfer.push.rejected

POSTyour webhook endpointWebhook

The receiving registrar rejected a push transfer.

domain.transfer.push.rejected › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.transfer.push.rejected › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

The receiving registrar rejected a push transfer.

Enum values:
domain.transfer.push.rejected
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.transfer.push.rejected › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.renewal.requested

POSTyour webhook endpointWebhook

A manual renewal was requested.

domain.renewal.requested › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.renewal.requested › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A manual renewal was requested.

Enum values:
domain.renewal.requested
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.renewal.requested › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.renewal.request_cancelled

POSTyour webhook endpointWebhook

An unpaid manual renewal was cancelled.

domain.renewal.request_cancelled › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.renewal.request_cancelled › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

An unpaid manual renewal was cancelled.

Enum values:
domain.renewal.request_cancelled
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.renewal.request_cancelled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.renewal.failed

POSTyour webhook endpointWebhook

A manual renewal was rejected.

domain.renewal.failed › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.renewal.failed › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A manual renewal was rejected.

Enum values:
domain.renewal.failed
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.renewal.failed › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.renewal.succeeded

POSTyour webhook endpointWebhook

A domain was renewed.

domain.renewal.succeeded › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.renewal.succeeded › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain was renewed.

Enum values:
domain.renewal.succeeded
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.renewal.succeeded › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.payment.received

POSTyour webhook endpointWebhook

Payment for a pending domain request was received.

domain.payment.received › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.payment.received › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

Payment for a pending domain request was received.

Enum values:
domain.payment.received
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.payment.received › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.delete.requested

POSTyour webhook endpointWebhook

A domain deletion was requested.

domain.delete.requested › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.delete.requested › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain deletion was requested.

Enum values:
domain.delete.requested
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.delete.requested › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.delete.failed

POSTyour webhook endpointWebhook

A domain deletion failed at the registry.

domain.delete.failed › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.delete.failed › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain deletion failed at the registry.

Enum values:
domain.delete.failed
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.delete.failed › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.restorable

POSTyour webhook endpointWebhook

A domain was deleted and can still be restored.

domain.restorable › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.restorable › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain was deleted and can still be restored.

Enum values:
domain.restorable
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.restorable › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.deleted

POSTyour webhook endpointWebhook

A domain was permanently deleted.

domain.deleted › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.deleted › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain was permanently deleted.

Enum values:
domain.deleted
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.deleted › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.expired

POSTyour webhook endpointWebhook

A domain expired.

domain.expired › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.expired › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain expired.

Enum values:
domain.expired
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.expired › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.restore.requested

POSTyour webhook endpointWebhook

A domain restore was requested.

domain.restore.requested › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.restore.requested › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain restore was requested.

Enum values:
domain.restore.requested
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.restore.requested › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.restore.request_cancelled

POSTyour webhook endpointWebhook

A pending domain restore was cancelled.

domain.restore.request_cancelled › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.restore.request_cancelled › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A pending domain restore was cancelled.

Enum values:
domain.restore.request_cancelled
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.restore.request_cancelled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.restore.succeeded

POSTyour webhook endpointWebhook

A domain was restored.

domain.restore.succeeded › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.restore.succeeded › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain was restored.

Enum values:
domain.restore.succeeded
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.restore.succeeded › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.restore.failed

POSTyour webhook endpointWebhook

A domain restore failed at the registry.

domain.restore.failed › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.restore.failed › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain restore failed at the registry.

Enum values:
domain.restore.failed
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.restore.failed › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.update.nameservers

POSTyour webhook endpointWebhook

A domain's nameservers were updated.

domain.update.nameservers › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.update.nameservers › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain's nameservers were updated.

Enum values:
domain.update.nameservers
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.update.nameservers › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.update.nameservers_failed

POSTyour webhook endpointWebhook

A nameserver update was rejected.

domain.update.nameservers_failed › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.update.nameservers_failed › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A nameserver update was rejected.

Enum values:
domain.update.nameservers_failed
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.update.nameservers_failed › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.update.lock_enabled

POSTyour webhook endpointWebhook

A domain's transfer lock was enabled.

domain.update.lock_enabled › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.update.lock_enabled › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain's transfer lock was enabled.

Enum values:
domain.update.lock_enabled
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.update.lock_enabled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.update.lock_disabled

POSTyour webhook endpointWebhook

A domain's transfer lock was disabled.

domain.update.lock_disabled › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.update.lock_disabled › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain's transfer lock was disabled.

Enum values:
domain.update.lock_disabled
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.update.lock_disabled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.update.lock_failed

POSTyour webhook endpointWebhook

A transfer lock update was rejected.

domain.update.lock_failed › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.update.lock_failed › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A transfer lock update was rejected.

Enum values:
domain.update.lock_failed
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.update.lock_failed › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.update.whois_privacy_enabled

POSTyour webhook endpointWebhook

A domain's WHOIS privacy was enabled.

domain.update.whois_privacy_enabled › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.update.whois_privacy_enabled › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain's WHOIS privacy was enabled.

Enum values:
domain.update.whois_privacy_enabled
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.update.whois_privacy_enabled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.update.whois_privacy_disabled

POSTyour webhook endpointWebhook

A domain's WHOIS privacy was disabled.

domain.update.whois_privacy_disabled › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.update.whois_privacy_disabled › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain's WHOIS privacy was disabled.

Enum values:
domain.update.whois_privacy_disabled
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.update.whois_privacy_disabled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.update.whois_privacy_failed

POSTyour webhook endpointWebhook

A WHOIS privacy update was rejected.

domain.update.whois_privacy_failed › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.update.whois_privacy_failed › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A WHOIS privacy update was rejected.

Enum values:
domain.update.whois_privacy_failed
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.update.whois_privacy_failed › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.update.auto_renew_enabled

POSTyour webhook endpointWebhook

A domain's auto-renewal was enabled.

domain.update.auto_renew_enabled › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.update.auto_renew_enabled › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain's auto-renewal was enabled.

Enum values:
domain.update.auto_renew_enabled
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.update.auto_renew_enabled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.update.auto_renew_disabled

POSTyour webhook endpointWebhook

A domain's auto-renewal was disabled.

domain.update.auto_renew_disabled › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.update.auto_renew_disabled › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain's auto-renewal was disabled.

Enum values:
domain.update.auto_renew_disabled
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.update.auto_renew_disabled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.update.auto_renew_failed

POSTyour webhook endpointWebhook

An auto-renewal update was rejected.

domain.update.auto_renew_failed › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.update.auto_renew_failed › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

An auto-renewal update was rejected.

Enum values:
domain.update.auto_renew_failed
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.update.auto_renew_failed › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.update.contacts

POSTyour webhook endpointWebhook

A domain's contacts were updated.

domain.update.contacts › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.update.contacts › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain's contacts were updated.

Enum values:
domain.update.contacts
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.update.contacts › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.update.contacts_failed

POSTyour webhook endpointWebhook

A contact update was rejected.

domain.update.contacts_failed › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.update.contacts_failed › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A contact update was rejected.

Enum values:
domain.update.contacts_failed
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.update.contacts_failed › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.update.contacts_and_whois_privacy_failed

POSTyour webhook endpointWebhook

A combined contact and WHOIS privacy update was rejected.

domain.update.contacts_and_whois_privacy_failed › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.update.contacts_and_whois_privacy_failed › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A combined contact and WHOIS privacy update was rejected.

Enum values:
domain.update.contacts_and_whois_privacy_failed
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.update.contacts_and_whois_privacy_failed › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.update.dnssec_keys

POSTyour webhook endpointWebhook

A domain's DNSSEC keys were updated.

domain.update.dnssec_keys › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.update.dnssec_keys › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain's DNSSEC keys were updated.

Enum values:
domain.update.dnssec_keys
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.update.dnssec_keys › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.update.dnssec_enabled

POSTyour webhook endpointWebhook

DNSSEC was enabled for a domain.

domain.update.dnssec_enabled › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.update.dnssec_enabled › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

DNSSEC was enabled for a domain.

Enum values:
domain.update.dnssec_enabled
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.update.dnssec_enabled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.update.dnssec_disabled

POSTyour webhook endpointWebhook

DNSSEC was disabled for a domain.

domain.update.dnssec_disabled › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.update.dnssec_disabled › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

DNSSEC was disabled for a domain.

Enum values:
domain.update.dnssec_disabled
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.update.dnssec_disabled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.update.dnssec_failed

POSTyour webhook endpointWebhook

A DNSSEC update was rejected.

domain.update.dnssec_failed › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.update.dnssec_failed › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A DNSSEC update was rejected.

Enum values:
domain.update.dnssec_failed
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.update.dnssec_failed › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.update.hosted_dns_enabled

POSTyour webhook endpointWebhook

Hosted DNS was enabled for a domain.

domain.update.hosted_dns_enabled › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.update.hosted_dns_enabled › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

Hosted DNS was enabled for a domain.

Enum values:
domain.update.hosted_dns_enabled
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.update.hosted_dns_enabled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.update.hosted_dns_disabled

POSTyour webhook endpointWebhook

Hosted DNS was disabled for a domain.

domain.update.hosted_dns_disabled › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.update.hosted_dns_disabled › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

Hosted DNS was disabled for a domain.

Enum values:
domain.update.hosted_dns_disabled
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.update.hosted_dns_disabled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.update.hosted_dns_sync_failed

POSTyour webhook endpointWebhook

Hosted DNS records failed to sync.

domain.update.hosted_dns_sync_failed › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.update.hosted_dns_sync_failed › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

Hosted DNS records failed to sync.

Enum values:
domain.update.hosted_dns_sync_failed
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.update.hosted_dns_sync_failed › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.update.hosted_dns_restored

POSTyour webhook endpointWebhook

Hosted DNS records were restored from DNS history.

domain.update.hosted_dns_restored › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.update.hosted_dns_restored › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

Hosted DNS records were restored from DNS history.

Enum values:
domain.update.hosted_dns_restored
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.update.hosted_dns_restored › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.update.hosted_dns_staged

POSTyour webhook endpointWebhook

Hosted DNS records are prepared before switching nameservers.

domain.update.hosted_dns_staged › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.update.hosted_dns_staged › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

Hosted DNS records are prepared before switching nameservers.

Enum values:
domain.update.hosted_dns_staged
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.update.hosted_dns_staged › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.update.hosted_dns_staging_cancelled

POSTyour webhook endpointWebhook

Preparing hosted DNS was cancelled.

domain.update.hosted_dns_staging_cancelled › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.update.hosted_dns_staging_cancelled › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

Preparing hosted DNS was cancelled.

Enum values:
domain.update.hosted_dns_staging_cancelled
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.update.hosted_dns_staging_cancelled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.dns.scheduled_change.created

POSTyour webhook endpointWebhook

A DNS change was scheduled.

domain.dns.scheduled_change.created › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.dns.scheduled_change.created › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A DNS change was scheduled.

Enum values:
domain.dns.scheduled_change.created
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.dns.scheduled_change.created › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.dns.scheduled_change.revised

POSTyour webhook endpointWebhook

A scheduled DNS change was revised.

domain.dns.scheduled_change.revised › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.dns.scheduled_change.revised › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A scheduled DNS change was revised.

Enum values:
domain.dns.scheduled_change.revised
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.dns.scheduled_change.revised › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.dns.scheduled_change.cancelled

POSTyour webhook endpointWebhook

A scheduled DNS change was cancelled.

domain.dns.scheduled_change.cancelled › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.dns.scheduled_change.cancelled › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A scheduled DNS change was cancelled.

Enum values:
domain.dns.scheduled_change.cancelled
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.dns.scheduled_change.cancelled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.dns.scheduled_change.applied

POSTyour webhook endpointWebhook

A scheduled DNS change was applied.

domain.dns.scheduled_change.applied › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.dns.scheduled_change.applied › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A scheduled DNS change was applied.

Enum values:
domain.dns.scheduled_change.applied
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.dns.scheduled_change.applied › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.dns.scheduled_change.conflicted

POSTyour webhook endpointWebhook

A scheduled DNS change stopped because records changed.

domain.dns.scheduled_change.conflicted › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.dns.scheduled_change.conflicted › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A scheduled DNS change stopped because records changed.

Enum values:
domain.dns.scheduled_change.conflicted
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.dns.scheduled_change.conflicted › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.dns.scheduled_change.superseded

POSTyour webhook endpointWebhook

A scheduled DNS change was replaced before it was published.

domain.dns.scheduled_change.superseded › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.dns.scheduled_change.superseded › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A scheduled DNS change was replaced before it was published.

Enum values:
domain.dns.scheduled_change.superseded
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.dns.scheduled_change.superseded › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.dns.scheduled_change.publish_failed

POSTyour webhook endpointWebhook

A scheduled DNS change could not be published.

domain.dns.scheduled_change.publish_failed › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.dns.scheduled_change.publish_failed › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A scheduled DNS change could not be published.

Enum values:
domain.dns.scheduled_change.publish_failed
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.dns.scheduled_change.publish_failed › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.mail_forward.renewed

POSTyour webhook endpointWebhook

Mail forwarding was renewed.

domain.mail_forward.renewed › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.mail_forward.renewed › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

Mail forwarding was renewed.

Enum values:
domain.mail_forward.renewed
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.mail_forward.renewed › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.mail_forward.enabled

POSTyour webhook endpointWebhook

Mail forwarding was enabled for a domain.

domain.mail_forward.enabled › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.mail_forward.enabled › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

Mail forwarding was enabled for a domain.

Enum values:
domain.mail_forward.enabled
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.mail_forward.enabled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.mail_forward.disabled

POSTyour webhook endpointWebhook

Mail forwarding was disabled for a domain.

domain.mail_forward.disabled › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.mail_forward.disabled › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

Mail forwarding was disabled for a domain.

Enum values:
domain.mail_forward.disabled
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.mail_forward.disabled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.transfer.internal

POSTyour webhook endpointWebhook

A domain moved to another upstream provider, for information only.

domain.transfer.internal › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.transfer.internal › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A domain moved to another upstream provider, for information only.

Enum values:
domain.transfer.internal
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.transfer.internal › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.contact_verification.required

POSTyour webhook endpointWebhook

The registrant of a domain must verify their contact details.

domain.contact_verification.required › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.contact_verification.required › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

The registrant of a domain must verify their contact details.

Enum values:
domain.contact_verification.required
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.contact_verification.required › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.contact_verification.approved

POSTyour webhook endpointWebhook

The registrant contact verification was approved.

domain.contact_verification.approved › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.contact_verification.approved › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

The registrant contact verification was approved.

Enum values:
domain.contact_verification.approved
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.contact_verification.approved › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.registry.suspension_scheduled

POSTyour webhook endpointWebhook

The registry scheduled a domain for suspension.

domain.registry.suspension_scheduled › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.registry.suspension_scheduled › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

The registry scheduled a domain for suspension.

Enum values:
domain.registry.suspension_scheduled
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.registry.suspension_scheduled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.registry.suspension_cancelled

POSTyour webhook endpointWebhook

The registry cancelled a scheduled suspension.

domain.registry.suspension_cancelled › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.registry.suspension_cancelled › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

The registry cancelled a scheduled suspension.

Enum values:
domain.registry.suspension_cancelled
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.registry.suspension_cancelled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.registry.suspended

POSTyour webhook endpointWebhook

The registry suspended a domain.

domain.registry.suspended › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.registry.suspended › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

The registry suspended a domain.

Enum values:
domain.registry.suspended
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.registry.suspended › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.registry.reinstated

POSTyour webhook endpointWebhook

The registry lifted a suspension.

domain.registry.reinstated › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.registry.reinstated › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

The registry lifted a suspension.

Enum values:
domain.registry.reinstated
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.registry.reinstated › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.registry.on_hold

POSTyour webhook endpointWebhook

The registry placed a domain on hold.

domain.registry.on_hold › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.registry.on_hold › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

The registry placed a domain on hold.

Enum values:
domain.registry.on_hold
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.registry.on_hold › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.registry.on_hold_removed

POSTyour webhook endpointWebhook

The registry removed a hold.

domain.registry.on_hold_removed › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.registry.on_hold_removed › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

The registry removed a hold.

Enum values:
domain.registry.on_hold_removed
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.registry.on_hold_removed › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.registry.seized

POSTyour webhook endpointWebhook

The registry seized a domain.

domain.registry.seized › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.registry.seized › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

The registry seized a domain.

Enum values:
domain.registry.seized
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.registry.seized › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.registry.seizure_removed

POSTyour webhook endpointWebhook

The registry lifted a seizure.

domain.registry.seizure_removed › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.registry.seizure_removed › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

The registry lifted a seizure.

Enum values:
domain.registry.seizure_removed
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.registry.seizure_removed › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

domain.imported

POSTyour webhook endpointWebhook

An existing domain was imported.

domain.imported › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

domain.imported › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

An existing domain was imported.

Enum values:
domain.imported
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

domain.imported › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

webhook_endpoint.test

POSTyour webhook endpointWebhook

A test event sent from the dashboard.

webhook_endpoint.test › Headers

webhook-id
​string · required

The event's id, the same on every attempt.

webhook-timestamp
​string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature
​string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

webhook_endpoint.test › Request Body

id
​string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: 01m6v3f5aydrktmzrbpz1pqh7e
type
​string · enum · required

A test event sent from the dashboard.

Enum values:
webhook_endpoint.test
timestamp
​string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version
​string · required

The version of the payload format.

Example: v1
​object · required

webhook_endpoint.test › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned