Class WebhookNewAITransformResultPayload

NEW_AI_TRANSFORM_RESULT webhook payload. Sent to your webhook url endpoint via HTTP POST when a structured data result is generated by the AI Transformer that your webhook is attached to. Use the AI Transform Result ID to fetch the full details.

Inheritance

object

WebhookNewAITransformResultPayload

Implements

IValidatableObject

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: mailslurp.Model

Assembly: mailslurp.dll

Syntax

[DataContract(Name = "WebhookNewAITransformResultPayload")]
public class WebhookNewAITransformResultPayload : IValidatableObject

Constructors

WebhookNewAITransformResultPayload()

Initializes a new instance of the WebhookNewAITransformResultPayload class.

Declaration

[JsonConstructor]
protected WebhookNewAITransformResultPayload()

WebhookNewAITransformResultPayload(string, Guid, EventNameEnum, string, Guid, Guid, Guid, Guid?, Guid?, EntityTypeEnum?, string)

Initializes a new instance of the WebhookNewAITransformResultPayload class.

Declaration

public WebhookNewAITransformResultPayload(string messageId = null, Guid webhookId = default, WebhookNewAITransformResultPayload.EventNameEnum eventName = (WebhookNewAITransformResultPayload.EventNameEnum)0, string webhookName = null, Guid aiTransformResultId = default, Guid userId = default, Guid aiTransformId = default, Guid? aiTransformMappingId = null, Guid? entityId = null, WebhookNewAITransformResultPayload.EntityTypeEnum? entityType = null, string result = null)

Parameters

Type	Name	Description
string	messageId	Idempotent message ID. Store this ID locally or in a database to prevent message duplication. (required).
Guid	webhookId	ID of webhook entity being triggered (required).
WebhookNewAITransformResultPayload.EventNameEnum	eventName	Name of the event type webhook is being triggered for. (required).
string	webhookName	Name of the webhook being triggered.
Guid	aiTransformResultId	AI Transform ID of event (required).
Guid	userId	User ID of event (required).
Guid	aiTransformId	ID of AI Transform (required).
Guid?	aiTransformMappingId	ID of AI Transform mapping.
Guid?	entityId	ID of entity that triggered the transformation.
WebhookNewAITransformResultPayload.EntityTypeEnum?	entityType	Entity type that triggered the transformation.
string	result	JSON string result of the AI transformation.

Properties

AiTransformId

ID of AI Transform

Declaration

[DataMember(Name = "aiTransformId", IsRequired = true, EmitDefaultValue = true)]
public Guid AiTransformId { get; set; }

Property Value

Type	Description
Guid	ID of AI Transform

AiTransformMappingId

ID of AI Transform mapping

Declaration

[DataMember(Name = "aiTransformMappingId", EmitDefaultValue = true)]
public Guid? AiTransformMappingId { get; set; }

Property Value

Type	Description
Guid?	ID of AI Transform mapping

AiTransformResultId

AI Transform ID of event

Declaration

[DataMember(Name = "aiTransformResultId", IsRequired = true, EmitDefaultValue = true)]
public Guid AiTransformResultId { get; set; }

Property Value

Type	Description
Guid	AI Transform ID of event

EntityId

ID of entity that triggered the transformation

Declaration

[DataMember(Name = "entityId", EmitDefaultValue = true)]
public Guid? EntityId { get; set; }

Property Value

Type	Description
Guid?	ID of entity that triggered the transformation

EntityType

Entity type that triggered the transformation

Declaration

[DataMember(Name = "entityType", EmitDefaultValue = true)]
public WebhookNewAITransformResultPayload.EntityTypeEnum? EntityType { get; set; }

Property Value

Type	Description
WebhookNewAITransformResultPayload.EntityTypeEnum?	Entity type that triggered the transformation

EventName

Name of the event type webhook is being triggered for.

Declaration

[DataMember(Name = "eventName", IsRequired = true, EmitDefaultValue = true)]
public WebhookNewAITransformResultPayload.EventNameEnum EventName { get; set; }

Property Value

Type	Description
WebhookNewAITransformResultPayload.EventNameEnum	Name of the event type webhook is being triggered for.

MessageId

Idempotent message ID. Store this ID locally or in a database to prevent message duplication.

Declaration

[DataMember(Name = "messageId", IsRequired = true, EmitDefaultValue = true)]
public string MessageId { get; set; }

Property Value

Type	Description
string	Idempotent message ID. Store this ID locally or in a database to prevent message duplication.

Result

JSON string result of the AI transformation

Declaration

[DataMember(Name = "result", EmitDefaultValue = true)]
public string Result { get; set; }

Property Value

Type	Description
string	JSON string result of the AI transformation

UserId

User ID of event

Declaration

[DataMember(Name = "userId", IsRequired = true, EmitDefaultValue = true)]
public Guid UserId { get; set; }

Property Value

Type	Description
Guid	User ID of event

WebhookId

ID of webhook entity being triggered

Declaration

[DataMember(Name = "webhookId", IsRequired = true, EmitDefaultValue = true)]
public Guid WebhookId { get; set; }

Property Value

Type	Description
Guid	ID of webhook entity being triggered

WebhookName

Name of the webhook being triggered

Declaration

[DataMember(Name = "webhookName", EmitDefaultValue = true)]
public string WebhookName { get; set; }

Property Value

Type	Description
string	Name of the webhook being triggered

Methods

ToJson()

Returns the JSON string presentation of the object

Declaration

public virtual string ToJson()

Returns

Type	Description
string	JSON string presentation of the object

ToString()

Returns the string presentation of the object

Declaration

public override string ToString()

Returns

Type	Description
string	String presentation of the object

Overrides

object.ToString()

Implements

IValidatableObject