com.mailgun.api.v3

Interface MailgunWebhooksApi

All Superinterfaces:

MailgunApi

public interface MailgunWebhooksApi
extends MailgunApi

Webhooks API allows you to create, access, and delete webhooks programmatically.

See Also:

Webhooks

Method Summary

Modifier and Type	Method and Description
WebhookResult	createNewWebhook(String domain, WebhookRequest request) Creates a new webhook.
feign.Response	createNewWebhookFeignResponse(String domain, WebhookRequest request) Creates a new webhook.
WebhookResult	deleteWebhook(String domain, WebhookName webhookName) Deletes an existing webhook.
feign.Response	deleteWebhookFeignResponse(String domain, WebhookName webhookName) Deletes an existing webhook.
WebhookListResult	getAllWebhooks(String domain) Returns a list of webhooks set for the specified domain.
feign.Response	getAllWebhooksFeignResponse(String domain) Returns a list of webhooks set for the specified domain.
WebhookDetailsResult	getWebhookDetails(String domain, WebhookName webhookName) Return details about a webhook specified in the URL.
feign.Response	getWebhookDetailsFeignResponse(String domain, WebhookName webhookName) Return details about a webhook specified in the URL.
WebhookResult	updateWebhook(String domain, WebhookName webhookName, WebhookUpdateRequest request) Updates an existing webhook.
feign.Response	updateWebhookFeignResponse(String domain, WebhookName webhookName, WebhookUpdateRequest request) Updates an existing webhook.

Methods inherited from interface com.mailgun.api.MailgunApi

getApiVersion

Method Detail

getAllWebhooks

WebhookListResult getAllWebhooks(String domain)

Returns a list of webhooks set for the specified domain.

Parameters:

domain - Name of the domain

Returns:

WebhookListResult

getAllWebhooksFeignResponse

feign.Response getAllWebhooksFeignResponse(String domain)

Returns a list of webhooks set for the specified domain.

Parameters:

domain - Name of the domain

Returns:

Response

getWebhookDetails

WebhookDetailsResult getWebhookDetails(String domain,
                                       WebhookName webhookName)

Return details about a webhook specified in the URL.

Parameters:

domain - Name of the domain

webhookName - Name of the webhook.

Returns:

WebhookDetailsResult

getWebhookDetailsFeignResponse

feign.Response getWebhookDetailsFeignResponse(String domain,
                                              WebhookName webhookName)

Return details about a webhook specified in the URL.

Parameters:

domain - Name of the domain

webhookName - Name of the webhook.

Returns:

Response

createNewWebhook

WebhookResult createNewWebhook(String domain,
                               WebhookRequest request)

Creates a new webhook.

Warning: When adding a Clicked or Opened webhook, ensure that you also have tracking enabled.

Parameters:

domain - Name of the domain

request - WebhookRequest

Returns:

WebhookResult

createNewWebhookFeignResponse

feign.Response createNewWebhookFeignResponse(String domain,
                                             WebhookRequest request)

Creates a new webhook. Warning: When adding a Clicked or Opened webhook, ensure that you also have tracking enabled.

Parameters:

domain - Name of the domain

request - WebhookRequest

Returns:

Response

updateWebhook

WebhookResult updateWebhook(String domain,
                            WebhookName webhookName,
                            WebhookUpdateRequest request)

Updates an existing webhook.

Parameters:

domain - Name of the domain

webhookName - Name of the webhook.

request - WebhookUpdateRequest

Returns:

WebhookResult

updateWebhookFeignResponse

feign.Response updateWebhookFeignResponse(String domain,
                                          WebhookName webhookName,
                                          WebhookUpdateRequest request)

Updates an existing webhook.

Parameters:

domain - Name of the domain

webhookName - Name of the webhook.

request - WebhookUpdateRequest

Returns:

Response

deleteWebhook

WebhookResult deleteWebhook(String domain,
                            WebhookName webhookName)

Deletes an existing webhook.

Parameters:

domain - Name of the domain

webhookName - Name of the webhook.

Returns:

WebhookResult

deleteWebhookFeignResponse

feign.Response deleteWebhookFeignResponse(String domain,
                                          WebhookName webhookName)

Deletes an existing webhook.

Parameters:

domain - Name of the domain

webhookName - Name of the webhook.

Returns:

Response