Package com.mailersend.sdk.webhooks

Class WebhooksBuilder

java.lang.Object

com.mailersend.sdk.webhooks.WebhooksBuilder

public class WebhooksBuilder
extends Object

WebhooksBuilder class.

Version:

$Id: $Id

Author:

mailersend

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WebhooksBuilder(MailerSend apiObjectRef)	No instantiation from outside the sdk

Method Summary

Modifier and Type	Method	Description
WebhooksBuilder	addEvent(String event)	Add an event for the webhook
WebhooksBuilder	clearEvents()	Clears the events of the webhook request
Webhook	createWebhook(String domainId)	Creates a webhook
WebhooksBuilder	name(String name)	Set the webhook's name
Webhook	updateWebhook(String webhookId)	Updates the webhook with the given id
WebhooksBuilder	url(String url)	Set the webhook's url

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebhooksBuilder

protected WebhooksBuilder(MailerSend apiObjectRef)

No instantiation from outside the sdk

Parameters:

apiObjectRef - a MailerSend object.

Method Detail

url

public WebhooksBuilder url(String url)

Set the webhook's url

Parameters:

url - a String object.

Returns:

a WebhooksBuilder object.

name

public WebhooksBuilder name(String name)

Set the webhook's name

Parameters:

name - a String object.

Returns:

a WebhooksBuilder object.

addEvent

public WebhooksBuilder addEvent(String event)

Add an event for the webhook

Parameters:

event - a String object.

Returns:

a WebhooksBuilder object.

clearEvents

public WebhooksBuilder clearEvents()

Clears the events of the webhook request

Returns:

a WebhooksBuilder object.

createWebhook

public Webhook createWebhook(String domainId)
                      throws MailerSendException

Creates a webhook

Parameters:

domainId - a String object.

Returns:

a Webhook object.

Throws:

MailerSendException

updateWebhook

public Webhook updateWebhook(String webhookId)
                      throws MailerSendException

Updates the webhook with the given id

Parameters:

webhookId - a String object.

Returns:

a Webhook object.

Throws:

MailerSendException