CreateWebhookChannelDetails¶

class oci.oda.models.CreateWebhookChannelDetails(**kwargs)¶

Bases: oci.oda.models.create_channel_details.CreateChannelDetails

Properties required to create a Webhook channel.

Attributes

`PAYLOAD_VERSION_1_0`	A constant which can be used with the payload_version property of a CreateWebhookChannelDetails.
`PAYLOAD_VERSION_1_1`	A constant which can be used with the payload_version property of a CreateWebhookChannelDetails.
`TYPE_ANDROID`	str(object=’’) -> str
`TYPE_APPEVENT`	str(object=’’) -> str
`TYPE_APPLICATION`	str(object=’’) -> str
`TYPE_CORTANA`	str(object=’’) -> str
`TYPE_FACEBOOK`	str(object=’’) -> str
`TYPE_IOS`	str(object=’’) -> str
`TYPE_MSTEAMS`	str(object=’’) -> str
`TYPE_OSS`	str(object=’’) -> str
`TYPE_OSVC`	str(object=’’) -> str
`TYPE_SERVICECLOUD`	str(object=’’) -> str
`TYPE_SLACK`	str(object=’’) -> str
`TYPE_TEST`	str(object=’’) -> str
`TYPE_TWILIO`	str(object=’’) -> str
`TYPE_WEB`	str(object=’’) -> str
`TYPE_WEBHOOK`	str(object=’’) -> str
`bot_id`	Gets the bot_id of this CreateWebhookChannelDetails.
`defined_tags`	Gets the defined_tags of this CreateChannelDetails.
`description`	Gets the description of this CreateChannelDetails.
`freeform_tags`	Gets the freeform_tags of this CreateChannelDetails.
`name`	[Required] Gets the name of this CreateChannelDetails.
`outbound_url`	[Required] Gets the outbound_url of this CreateWebhookChannelDetails.
`payload_version`	[Required] Gets the payload_version of this CreateWebhookChannelDetails.
`session_expiry_duration_in_milliseconds`	Gets the session_expiry_duration_in_milliseconds of this CreateChannelDetails.
`type`	[Required] Gets the type of this CreateChannelDetails.

Methods

`__init__`(**kwargs)	Initializes a new CreateWebhookChannelDetails object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

PAYLOAD_VERSION_1_0 = '1.0'¶: A constant which can be used with the payload_version property of a CreateWebhookChannelDetails. This constant has a value of “1.0”

PAYLOAD_VERSION_1_1 = '1.1'¶: A constant which can be used with the payload_version property of a CreateWebhookChannelDetails. This constant has a value of “1.1”

TYPE_ANDROID = 'ANDROID'¶

TYPE_APPEVENT = 'APPEVENT'¶

TYPE_APPLICATION = 'APPLICATION'¶

TYPE_CORTANA = 'CORTANA'¶

TYPE_FACEBOOK = 'FACEBOOK'¶

TYPE_IOS = 'IOS'¶

TYPE_MSTEAMS = 'MSTEAMS'¶

TYPE_OSS = 'OSS'¶

TYPE_OSVC = 'OSVC'¶

TYPE_SERVICECLOUD = 'SERVICECLOUD'¶

TYPE_SLACK = 'SLACK'¶

TYPE_TEST = 'TEST'¶

TYPE_TWILIO = 'TWILIO'¶

TYPE_WEB = 'WEB'¶

TYPE_WEBHOOK = 'WEBHOOK'¶

__init__(**kwargs)¶

Initializes a new CreateWebhookChannelDetails object with values from keyword arguments. The default value of the type attribute of this class is WEBHOOK and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

name (str) – The value to assign to the name property of this CreateWebhookChannelDetails.
description (str) – The value to assign to the description property of this CreateWebhookChannelDetails.
type (str) – The value to assign to the type property of this CreateWebhookChannelDetails. Allowed values for this property are: “ANDROID”, “APPEVENT”, “APPLICATION”, “CORTANA”, “FACEBOOK”, “IOS”, “MSTEAMS”, “OSS”, “OSVC”, “SERVICECLOUD”, “SLACK”, “TEST”, “TWILIO”, “WEB”, “WEBHOOK”
session_expiry_duration_in_milliseconds (int) – The value to assign to the session_expiry_duration_in_milliseconds property of this CreateWebhookChannelDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateWebhookChannelDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateWebhookChannelDetails.
outbound_url (str) – The value to assign to the outbound_url property of this CreateWebhookChannelDetails.
payload_version (str) – The value to assign to the payload_version property of this CreateWebhookChannelDetails. Allowed values for this property are: “1.0”, “1.1”
bot_id (str) – The value to assign to the bot_id property of this CreateWebhookChannelDetails.

bot_id¶

Gets the bot_id of this CreateWebhookChannelDetails. The ID of the Skill or Digital Assistant that the Channel is routed to.

Returns:	The bot_id of this CreateWebhookChannelDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this CreateChannelDetails. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this CreateChannelDetails.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this CreateChannelDetails. A short description of the Channel.

Returns:	The description of this CreateChannelDetails.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this CreateChannelDetails. Simple key-value pair that is applied without any predefined name, type, or scope. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this CreateChannelDetails.
Return type:	dict(str, str)

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

name¶

[Required] Gets the name of this CreateChannelDetails. The Channel’s name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter.

Returns:	The name of this CreateChannelDetails.
Return type:	str

outbound_url¶

[Required] Gets the outbound_url of this CreateWebhookChannelDetails. The URL to send responses to.

Returns:	The outbound_url of this CreateWebhookChannelDetails.
Return type:	str

payload_version¶

[Required] Gets the payload_version of this CreateWebhookChannelDetails. The version for payloads.

Allowed values for this property are: “1.0”, “1.1”

Returns:	The payload_version of this CreateWebhookChannelDetails.
Return type:	str

session_expiry_duration_in_milliseconds¶

Gets the session_expiry_duration_in_milliseconds of this CreateChannelDetails. The number of milliseconds before a session expires.

Returns:	The session_expiry_duration_in_milliseconds of this CreateChannelDetails.
Return type:	int

type¶

[Required] Gets the type of this CreateChannelDetails. The Channel type.

Allowed values for this property are: “ANDROID”, “APPEVENT”, “APPLICATION”, “CORTANA”, “FACEBOOK”, “IOS”, “MSTEAMS”, “OSS”, “OSVC”, “SERVICECLOUD”, “SLACK”, “TEST”, “TWILIO”, “WEB”, “WEBHOOK”

Returns:	The type of this CreateChannelDetails.
Return type:	str