Webhooks API

Webhooks are used for receiving notifications via an HTTP request whenever an event occurs in your DNSimple account. For more information visit the Webhook and Events section.

You can register a webhook URLs using the API endpints below to subscribe to account events. The URL must use HTTPS and the webhook handler should be able to receive HTTP POST requests.

List webhooks

GET /:account/webhooks

List webhooks in the account.

Parameters

Name Type Description
:account integer The account id

Example

List all webhooks in the account 1010:

curl  -H 'Authorization: Bearer <token>' \
      -H 'Accept: application/json' \
      https://api.dnsimple.com/v2/1010/webhooks

Response

Responds with HTTP 200.

{
  "data": [
    {
      "id": 1,
      "url": "https://webhook.test"
    },
    {
      "id": 2,
      "url": "https://another.test"
    }
  ]
}

Sorting

For general information about sorting, please refer to the main guide.

Name Description
id Sort webhooks by ID

The default sorting policy is by ascending id.

Create a webhook

POST /:account/webhooks

Parameters

Name Type Description
:account integer The account id

Example

Create a webhook in the account 1010:

curl  -H 'Authorization: Bearer <token>' \
      -H 'Accept: application/json' \
      -H 'Content-Type: application/json' \
      -X POST \
      -d '{"url":"https://test.host/handler"}' \
      https://api.dnsimple.com/v2/1010/webhooks

Input

Name Type Description
url string Required.
Example
{
  "url": "https://test.host/handler"
}

Response

Responds with HTTP 201 on success.

{
  "data": {
    "id": 1,
    "url": "https://webhook.test"
  }
}

Responds with HTTP 400 if the validation fails.

Retrieve a webhook

GET /:account/webhooks/:webhook

Parameters

Name Type Description
:account integer The account id
:webhook integer, string The webhook id

Example

Get the webhook with ID 1 in the account 1010:

curl  -H 'Authorization: Bearer <token>' \
      -H 'Accept: application/json' \
      https://api.dnsimple.com/v2/1010/webhooks/1

Response

{
  "data": {
    "id": 1,
    "url": "https://webhook.test"
  }
}

Delete a webhook

DELETE /:account/webhooks/:webhook

Parameters

Name Type Description
:account integer The account id
:webhook integer, string The webhook id

Example

Delete the webhook with ID 1 in the account 1010:

curl  -H 'Authorization: Bearer <token>' \
      -H 'Accept: application/json' \
      -X DELETE \
      https://api.dnsimple.com/v2/1010/webhooks/1

Response

Responds with HTTP 204 on success.