com.twilio.rest.chat.v2.service.channel

Class WebhookCreator

java.lang.Object

com.twilio.base.Creator<Webhook>

com.twilio.rest.chat.v2.service.channel.WebhookCreator

public class WebhookCreator
extends Creator<Webhook>

Constructor Summary

Constructors

Constructor and Description
WebhookCreator(String pathServiceSid, String pathChannelSid, Webhook.Type type) Construct a new WebhookCreator.

Method Summary

Modifier and Type	Method and Description
Webhook	create(TwilioRestClient client) Make the request to the Twilio API to perform the create.
WebhookCreator	setConfigurationFilters(List<String> configurationFilters) The events that cause us to call the Channel Webhook.
WebhookCreator	setConfigurationFilters(String configurationFilters) The events that cause us to call the Channel Webhook.
WebhookCreator	setConfigurationFlowSid(String configurationFlowSid) The SID of the Studio [Flow](https://www.twilio.com/docs/studio/rest-api/flow) to call when an event in `configuration.filters` occurs.
WebhookCreator	setConfigurationMethod(Webhook.Method configurationMethod) The HTTP method used to call `configuration.url`.
WebhookCreator	setConfigurationRetryCount(Integer configurationRetryCount) The number of times to retry the webhook if the first attempt fails.
WebhookCreator	setConfigurationTriggers(List<String> configurationTriggers) A string that will cause us to call the webhook when it is present in a message body.
WebhookCreator	setConfigurationTriggers(String configurationTriggers) A string that will cause us to call the webhook when it is present in a message body.
WebhookCreator	setConfigurationUrl(String configurationUrl) The URL of the webhook to call using the `configuration.method`..

Methods inherited from class com.twilio.base.Creator

create, createAsync, createAsync

Methods inherited from class java.lang.Object

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

Constructor Detail

WebhookCreator

public WebhookCreator(String pathServiceSid,
                      String pathChannelSid,
                      Webhook.Type type)

Construct a new WebhookCreator.

Parameters:

pathServiceSid - The SID of the Service with the Channel to create the resource under

pathChannelSid - The SID of the Channel the new resource belongs to

type - The type of webhook

Method Detail

setConfigurationUrl

public WebhookCreator setConfigurationUrl(String configurationUrl)

The URL of the webhook to call using the `configuration.method`..

Parameters:

configurationUrl - The URL of the webhook to call

Returns:

this

setConfigurationMethod

public WebhookCreator setConfigurationMethod(Webhook.Method configurationMethod)

The HTTP method used to call `configuration.url`. Can be: `GET` or `POST` and the default is `POST`..

Parameters:

configurationMethod - The HTTP method used to call `configuration.url`

Returns:

this

setConfigurationFilters

public WebhookCreator setConfigurationFilters(List<String> configurationFilters)

The events that cause us to call the Channel Webhook. Used when `type` is `webhook`. This parameter takes only one event. To specify more than one event, repeat this parameter for each event. For the list of possible events, see [Webhook Event Triggers](https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger)..

Parameters:

configurationFilters - The events that cause us to call the Channel Webhook

Returns:

this

setConfigurationFilters

public WebhookCreator setConfigurationFilters(String configurationFilters)

The events that cause us to call the Channel Webhook. Used when `type` is `webhook`. This parameter takes only one event. To specify more than one event, repeat this parameter for each event. For the list of possible events, see [Webhook Event Triggers](https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger)..

Parameters:

configurationFilters - The events that cause us to call the Channel Webhook

Returns:

this

setConfigurationTriggers

public WebhookCreator setConfigurationTriggers(List<String> configurationTriggers)

A string that will cause us to call the webhook when it is present in a message body. This parameter takes only one trigger string. To specify more than one, repeat this parameter for each trigger string up to a total of 5 trigger strings. Used only when `type` = `trigger`..

Parameters:

configurationTriggers - A string that will cause us to call the webhook when it is found in a message body

Returns:

this

setConfigurationTriggers

public WebhookCreator setConfigurationTriggers(String configurationTriggers)

A string that will cause us to call the webhook when it is present in a message body. This parameter takes only one trigger string. To specify more than one, repeat this parameter for each trigger string up to a total of 5 trigger strings. Used only when `type` = `trigger`..

Parameters:

configurationTriggers - A string that will cause us to call the webhook when it is found in a message body

Returns:

this

setConfigurationFlowSid

public WebhookCreator setConfigurationFlowSid(String configurationFlowSid)

The SID of the Studio [Flow](https://www.twilio.com/docs/studio/rest-api/flow) to call when an event in `configuration.filters` occurs. Used only when `type` is `studio`..

Parameters:

configurationFlowSid - The SID of the Studio Flow to call when an event occurs

Returns:

this

setConfigurationRetryCount

public WebhookCreator setConfigurationRetryCount(Integer configurationRetryCount)

The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0..

Parameters:

configurationRetryCount - The number of times to retry the webhook if the first attempt fails

Returns:

this

create

public Webhook create(TwilioRestClient client)

Make the request to the Twilio API to perform the create.

Specified by:

create in class Creator<Webhook>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Created Webhook