# InboundTrigger

> Tracon documentation. Tracon is a .NET package family that adds a control
> plane on Microsoft Agent Framework, published as NuGet packages that run
> inside your own ASP.NET Core application.
>
> Page: https://tracon.dev/api/tracon.inboundtrigger/
> Summary: InboundTrigger: An inbound trigger definition: an external event that starts a queued run.

<div class="api-provenance">Namespace Tracon · Assembly <code>Tracon.Abstractions.dll</code></div>

An inbound trigger definition: an external event that starts a queued run.

```csharp
public sealed record InboundTrigger : IEquatable<InboundTrigger>
```

<dl class="api-relations"><dt>Inheritance</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ← <a href="/api/tracon.inboundtrigger/">InboundTrigger</a></dd><dt>Implements</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable&lt;InboundTrigger&gt;</a></dd><dt>Inherited Members</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a></dd></dl>

## Remarks

A trigger is identified on the wire by `TenantId` +
`Name` (`POST /api/triggers/{tenantId}/{name}`). The
caller authenticates with an HMAC signature over the request body, the
same `WebhookSigner` contract the outbound webhooks use, in
the reverse direction.

`SigningSecretConfigurationName` is the configuration
KEY'S NAME, never the secret's value. The value is resolved from
`IConfiguration` at request time and is never written to a database
or a file.

## Constructors

### <a id="Tracon_InboundTrigger__ctor"></a> InboundTrigger\(\)

```csharp
public InboundTrigger()
```

## Properties

### <a id="Tracon_InboundTrigger_CreatedAt"></a> CreatedAt

The creation time (UTC).

```csharp
public required DateTimeOffset CreatedAt { get; init; }
```

#### Property Value

 [DateTimeOffset](https://learn.microsoft.com/dotnet/api/system.datetimeoffset)

### <a id="Tracon_InboundTrigger_Enabled"></a> Enabled

Whether the trigger accepts requests. A disabled trigger rejects every request.

```csharp
public bool Enabled { get; init; }
```

#### Property Value

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="Tracon_InboundTrigger_Id"></a> Id

The trigger identifier.

```csharp
public Guid Id { get; init; }
```

#### Property Value

 [Guid](https://learn.microsoft.com/dotnet/api/system.guid)

### <a id="Tracon_InboundTrigger_Name"></a> Name

The trigger name, unique within the tenant.

```csharp
public required string Name { get; init; }
```

#### Property Value

 [string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="Tracon_InboundTrigger_PayloadMode"></a> PayloadMode

How the request body becomes the run's message.

```csharp
public InboundTriggerPayloadMode PayloadMode { get; init; }
```

#### Property Value

 [InboundTriggerPayloadMode](/api/tracon.inboundtriggerpayloadmode/)

### <a id="Tracon_InboundTrigger_PayloadPath"></a> PayloadPath

The dotted path used when [InboundTrigger.PayloadMode](/api/tracon.inboundtrigger/#Tracon_InboundTrigger_PayloadMode) is
[InboundTriggerPayloadMode.Path](/api/tracon.inboundtriggerpayloadmode/); otherwise [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null).

```csharp
public string? PayloadPath { get; init; }
```

#### Property Value

 [string](https://learn.microsoft.com/dotnet/api/system.string)?

### <a id="Tracon_InboundTrigger_SigningSecretConfigurationName"></a> SigningSecretConfigurationName

The configuration KEY NAME of the signing secret. Never the value itself.

```csharp
public required string SigningSecretConfigurationName { get; init; }
```

#### Property Value

 [string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="Tracon_InboundTrigger_TargetKind"></a> TargetKind

The kind of target the trigger starts.

```csharp
public required InboundTriggerTargetKind TargetKind { get; init; }
```

#### Property Value

 [InboundTriggerTargetKind](/api/tracon.inboundtriggertargetkind/)

### <a id="Tracon_InboundTrigger_TargetName"></a> TargetName

The agent or workflow name to run.

```csharp
public required string TargetName { get; init; }
```

#### Property Value

 [string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="Tracon_InboundTrigger_TenantId"></a> TenantId

The tenant the trigger belongs to.

```csharp
public required string TenantId { get; init; }
```

#### Property Value

 [string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="Tracon_InboundTrigger_UpdatedAt"></a> UpdatedAt

The last-updated time (UTC).

```csharp
public required DateTimeOffset UpdatedAt { get; init; }
```

#### Property Value

 [DateTimeOffset](https://learn.microsoft.com/dotnet/api/system.datetimeoffset)

## Methods

### <a id="Tracon_InboundTrigger_Equals_System_Object_"></a> Equals\(object?\)

```csharp
public override bool Equals(object? obj)
```

#### Parameters

`obj` [object](https://learn.microsoft.com/dotnet/api/system.object)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="Tracon_InboundTrigger_Equals_Tracon_InboundTrigger_"></a> Equals\(InboundTrigger?\)

```csharp
public bool Equals(InboundTrigger? other)
```

#### Parameters

`other` [InboundTrigger](/api/tracon.inboundtrigger/)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="Tracon_InboundTrigger_GetHashCode"></a> GetHashCode\(\)

```csharp
public override int GetHashCode()
```

#### Returns

 [int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="Tracon_InboundTrigger_ToString"></a> ToString\(\)

```csharp
public override string ToString()
```

#### Returns

 [string](https://learn.microsoft.com/dotnet/api/system.string)

## Operators

### <a id="Tracon_InboundTrigger_op_Equality_Tracon_InboundTrigger_Tracon_InboundTrigger_"></a> operator ==\(InboundTrigger?, InboundTrigger?\)

```csharp
public static bool operator ==(InboundTrigger? left, InboundTrigger? right)
```

#### Parameters

`left` [InboundTrigger](/api/tracon.inboundtrigger/)?

`right` [InboundTrigger](/api/tracon.inboundtrigger/)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="Tracon_InboundTrigger_op_Inequality_Tracon_InboundTrigger_Tracon_InboundTrigger_"></a> operator \!=\(InboundTrigger?, InboundTrigger?\)

```csharp
public static bool operator !=(InboundTrigger? left, InboundTrigger? right)
```

#### Parameters

`left` [InboundTrigger](/api/tracon.inboundtrigger/)?

`right` [InboundTrigger](/api/tracon.inboundtrigger/)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)