Class CreateWebhookChannelResult

The configuration for a Webhook channel.

Inheritance

object

CreateChannelResult

CreateWebhookChannelResult

Inherited Members

CreateChannelResult.Id

CreateChannelResult.Name

CreateChannelResult.Description

CreateChannelResult.Category

CreateChannelResult.SessionExpiryDurationInMilliseconds

CreateChannelResult.LifecycleState

CreateChannelResult.TimeCreated

CreateChannelResult.TimeUpdated

CreateChannelResult.FreeformTags

CreateChannelResult.DefinedTags

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.OdaService.Models

Assembly: OCI.DotNetSDK.Oda.dll

Syntax

public class CreateWebhookChannelResult : CreateChannelResult

Properties

BotId

Declaration

[JsonProperty(PropertyName = "botId")]
public string BotId { get; set; }

Property Value

Type	Description
string	The ID of the Skill or Digital Assistant that the Channel is routed to.

OutboundUrl

Declaration

[Required(ErrorMessage = "OutboundUrl is required.")]
[JsonProperty(PropertyName = "outboundUrl")]
public string OutboundUrl { get; set; }

Property Value

Type	Description
string	The URL to send responses to.

Remarks

Required

PayloadVersion

Declaration

[Required(ErrorMessage = "PayloadVersion is required.")]
[JsonProperty(PropertyName = "payloadVersion")]
[JsonConverter(typeof(ResponseEnumConverter))]
public WebhookPayloadVersion? PayloadVersion { get; set; }

Property Value

Type	Description
WebhookPayloadVersion?	The version for payloads.

Remarks

Required

SecretKey

Declaration

[Required(ErrorMessage = "SecretKey is required.")]
[JsonProperty(PropertyName = "secretKey")]
public string SecretKey { get; set; }

Property Value

Type	Description
string	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.

Remarks

Required

WebhookUrl

Declaration

[Required(ErrorMessage = "WebhookUrl is required.")]
[JsonProperty(PropertyName = "webhookUrl")]
public string WebhookUrl { get; set; }

Property Value

Type	Description
string	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.

Remarks

Required