CreateWebhookChannelResult¶

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

Bases: oci.oda.models.create_channel_result.CreateChannelResult

The configuration for a Webhook channel.

Attributes

`CATEGORY_AGENT`	str(object=’’) -> str
`CATEGORY_APPLICATION`	str(object=’’) -> str
`CATEGORY_BOT`	str(object=’’) -> str
`CATEGORY_BOT_AS_AGENT`	str(object=’’) -> str
`CATEGORY_EVENT`	str(object=’’) -> str
`CATEGORY_SYSTEM`	str(object=’’) -> str
`LIFECYCLE_STATE_ACTIVE`	str(object=’’) -> str
`LIFECYCLE_STATE_CREATING`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETED`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETING`	str(object=’’) -> str
`LIFECYCLE_STATE_FAILED`	str(object=’’) -> str
`LIFECYCLE_STATE_INACTIVE`	str(object=’’) -> str
`LIFECYCLE_STATE_UPDATING`	str(object=’’) -> str
`PAYLOAD_VERSION_1_0`	A constant which can be used with the payload_version property of a CreateWebhookChannelResult.
`PAYLOAD_VERSION_1_1`	A constant which can be used with the payload_version property of a CreateWebhookChannelResult.
`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 CreateWebhookChannelResult.
`category`	[Required] Gets the category of this CreateChannelResult.
`defined_tags`	Gets the defined_tags of this CreateChannelResult.
`description`	Gets the description of this CreateChannelResult.
`freeform_tags`	Gets the freeform_tags of this CreateChannelResult.
`id`	[Required] Gets the id of this CreateChannelResult.
`lifecycle_state`	[Required] Gets the lifecycle_state of this CreateChannelResult.
`name`	[Required] Gets the name of this CreateChannelResult.
`outbound_url`	[Required] Gets the outbound_url of this CreateWebhookChannelResult.
`payload_version`	[Required] Gets the payload_version of this CreateWebhookChannelResult.
`secret_key`	[Required] Gets the secret_key of this CreateWebhookChannelResult.
`session_expiry_duration_in_milliseconds`	Gets the session_expiry_duration_in_milliseconds of this CreateChannelResult.
`time_created`	[Required] Gets the time_created of this CreateChannelResult.
`time_updated`	[Required] Gets the time_updated of this CreateChannelResult.
`type`	[Required] Gets the type of this CreateChannelResult.
`webhook_url`	[Required] Gets the webhook_url of this CreateWebhookChannelResult.

Methods

`__init__`(**kwargs)	Initializes a new CreateWebhookChannelResult 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.

CATEGORY_AGENT = 'AGENT'¶

CATEGORY_APPLICATION = 'APPLICATION'¶

CATEGORY_BOT = 'BOT'¶

CATEGORY_BOT_AS_AGENT = 'BOT_AS_AGENT'¶

CATEGORY_EVENT = 'EVENT'¶

CATEGORY_SYSTEM = 'SYSTEM'¶

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶

LIFECYCLE_STATE_CREATING = 'CREATING'¶

LIFECYCLE_STATE_DELETED = 'DELETED'¶

LIFECYCLE_STATE_DELETING = 'DELETING'¶

LIFECYCLE_STATE_FAILED = 'FAILED'¶

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶

PAYLOAD_VERSION_1_0 = '1.0'¶: A constant which can be used with the payload_version property of a CreateWebhookChannelResult. 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 CreateWebhookChannelResult. 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 CreateWebhookChannelResult 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:

id (str) – The value to assign to the id property of this CreateWebhookChannelResult.
name (str) – The value to assign to the name property of this CreateWebhookChannelResult.
description (str) – The value to assign to the description property of this CreateWebhookChannelResult.
category (str) – The value to assign to the category property of this CreateWebhookChannelResult. Allowed values for this property are: “AGENT”, “APPLICATION”, “BOT”, “BOT_AS_AGENT”, “SYSTEM”, “EVENT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
type (str) – The value to assign to the type property of this CreateWebhookChannelResult. Allowed values for this property are: “ANDROID”, “APPEVENT”, “APPLICATION”, “CORTANA”, “FACEBOOK”, “IOS”, “MSTEAMS”, “OSS”, “OSVC”, “SERVICECLOUD”, “SLACK”, “TEST”, “TWILIO”, “WEB”, “WEBHOOK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
session_expiry_duration_in_milliseconds (int) – The value to assign to the session_expiry_duration_in_milliseconds property of this CreateWebhookChannelResult.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this CreateWebhookChannelResult. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this CreateWebhookChannelResult.
time_updated (datetime) – The value to assign to the time_updated property of this CreateWebhookChannelResult.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateWebhookChannelResult.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateWebhookChannelResult.
secret_key (str) – The value to assign to the secret_key property of this CreateWebhookChannelResult.
outbound_url (str) – The value to assign to the outbound_url property of this CreateWebhookChannelResult.
payload_version (str) – The value to assign to the payload_version property of this CreateWebhookChannelResult. Allowed values for this property are: “1.0”, “1.1”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
bot_id (str) – The value to assign to the bot_id property of this CreateWebhookChannelResult.
webhook_url (str) – The value to assign to the webhook_url property of this CreateWebhookChannelResult.

bot_id¶

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

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

category¶

[Required] Gets the category of this CreateChannelResult. The category of the Channel.

Allowed values for this property are: “AGENT”, “APPLICATION”, “BOT”, “BOT_AS_AGENT”, “SYSTEM”, “EVENT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The category of this CreateChannelResult.
Return type:	str

defined_tags¶

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

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

description¶

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

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

freeform_tags¶

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

Returns:	The freeform_tags of this CreateChannelResult.
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.

id¶

[Required] Gets the id of this CreateChannelResult. Unique immutable identifier that was assigned when the Channel was created.

Returns:	The id of this CreateChannelResult.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this CreateChannelResult. The Channel’s current state.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this CreateChannelResult.
Return type:	str

name¶

[Required] Gets the name of this CreateChannelResult. 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 CreateChannelResult.
Return type:	str

outbound_url¶

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

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

payload_version¶

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

Allowed values for this property are: “1.0”, “1.1”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

secret_key¶

[Required] Gets the secret_key of this CreateWebhookChannelResult. The secret key used to verify the authenticity of received messages. This is only returned this once. If it is lost the keys will need to be rotated to generate a new key.

Returns:	The secret_key of this CreateWebhookChannelResult.
Return type:	str

session_expiry_duration_in_milliseconds¶

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

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

time_created¶

[Required] Gets the time_created of this CreateChannelResult. When the resource was created. A date-time string as described in RFC 3339, section 14.29.

Returns:	The time_created of this CreateChannelResult.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this CreateChannelResult. When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.

Returns:	The time_updated of this CreateChannelResult.
Return type:	datetime

type¶

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

Allowed values for this property are: “ANDROID”, “APPEVENT”, “APPLICATION”, “CORTANA”, “FACEBOOK”, “IOS”, “MSTEAMS”, “OSS”, “OSVC”, “SERVICECLOUD”, “SLACK”, “TEST”, “TWILIO”, “WEB”, “WEBHOOK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

webhook_url¶

[Required] Gets the webhook_url of this CreateWebhookChannelResult. The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel.

Returns:	The webhook_url of this CreateWebhookChannelResult.
Return type:	str