com.dnsimple

Interface Webhooks

All Known Implementing Classes:

WebhooksEndpoint

public interface Webhooks

Method Summary

Modifier and Type	Method and Description
CreateWebhookResponse	createWebhook(String accountId, Map<String,Object> attributes) Create a webhook in the account.
DeleteWebhookResponse	deleteWebhook(String accountId, String webhookId) Delete a webhook from the account.
GetWebhookResponse	getWebhook(String accountId, String webhookId) Get a specific webhook associated to an account using the webhook's ID.
ListWebhooksResponse	listWebhooks(String accountId) Lists the webhooks in the account.
ListWebhooksResponse	listWebhooks(String accountId, Map<String,Object> options) Lists the webhooks in the account.

Method Detail

listWebhooks

ListWebhooksResponse listWebhooks(String accountId)
                           throws DnsimpleException,
                                  IOException

Lists the webhooks in the account.

Parameters:

accountId - The account ID

Returns:

The list webhooks response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/webhooks/#list

listWebhooks

ListWebhooksResponse listWebhooks(String accountId,
                                  Map<String,Object> options)
                           throws DnsimpleException,
                                  IOException

Lists the webhooks in the account.

Parameters:

accountId - The account ID

options - A Map of options to pass to the webhooks API

Returns:

The list webhooks response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/webhooks/#list

getWebhook

GetWebhookResponse getWebhook(String accountId,
                              String webhookId)
                       throws DnsimpleException,
                              IOException

Get a specific webhook associated to an account using the webhook's ID.

Parameters:

accountId - The account ID

webhookId - The webhook ID

Returns:

The get webhook response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/webhooks/#get

createWebhook

CreateWebhookResponse createWebhook(String accountId,
                                    Map<String,Object> attributes)
                             throws DnsimpleException,
                                    IOException

Create a webhook in the account.

Parameters:

accountId - The account ID

attributes - A Map of attributes for constructing the webhook

Returns:

The create webhook response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/webhooks/#create

deleteWebhook

DeleteWebhookResponse deleteWebhook(String accountId,
                                    String webhookId)
                             throws DnsimpleException,
                                    IOException

Delete a webhook from the account.

Parameters:

accountId - The account ID

webhookId - The webhook ID

Returns:

The delete webhook response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/webhooks/#delete