accounts1

billing2

contacts5

domain certificates8

domain dnssec7

domain emailforwards4

domain pushes4

domain services5

domains5

identity2

registrant changes5

registrar5

registrar delegation4

registrar privacy2

registrar registration1

registrar renewal4

registrar restore2

registrar transfer5

secondary dns7

templates10

tlds3

vanity name servers2

webhooks4

zones14

webhooks

Create a webhook

Changed on Jul 11, 2025

Registers a webhook endpoint.

post/{account}/webhooks

Request

Base URL
https://api.dnsimple.com/v2
Auth
- HTTP basic
- or HTTP bearer
TypeScript
https://skmtc.dev/dnsimple/apis/dnsimple-api/docs/:account/webhooks/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

accountinteger required

The account id

Request body

urlstring uri required

Response

Successfully created a webhook.

Example response

{
  "data": {
    "id": 1,
    "url": "https://webhook.test",
    "suppressed_at": "2022-06-07T17:45:13Z"
  }
}

Changes

Jul 11, 2025v206780be0ef17 Revision changes
- breaking
  the response property / became nullable for the status
- info
  the response property became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
Jul 18, 2023v2c8591dcf8c29 Revision changes
- breaking
  the response property became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status

Operation history