All Implemented Interfaces:

app.knock.api.core.Params
```
public final class WorkflowTriggerParams
 implements Params
                    
```
Trigger a workflow (specified by the key) to run for the given recipients, using the parameters provided. Returns an identifier for the workflow run request. All workflow runs are executed asynchronously. This endpoint also handles /managing-recipients/identifying-recipients#inline-identifying-recipients for the actor, recipient, and tenant fields.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`WorkflowTriggerParams.Builder`	A builder for WorkflowTriggerParams.
`public final class`	`WorkflowTriggerParams.Body`	A request to trigger a notification workflow.
`public final class`	`WorkflowTriggerParams.Data`	An optional map of data to pass into the workflow execution.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Optional<String>`	`key()`
`final List<RecipientRequest>`	`recipients()`	The recipients to trigger the workflow for.
`final Optional<RecipientRequest>`	`actor()`	Specifies a recipient in a request.
`final Optional<String>`	`cancellationKey()`	An optional key that is used to reference a specific workflow trigger request when issuing a /send-notifications/canceling-workflows request.
`final Optional<WorkflowTriggerParams.Data>`	`data()`	An optional map of data to pass into the workflow execution.
`final Optional<InlineTenantRequest>`	`tenant()`	An request to set a tenant inline.
`final JsonField<List<RecipientRequest>>`	`_recipients()`	Returns the raw JSON value of recipients.
`final JsonField<RecipientRequest>`	`_actor()`	Returns the raw JSON value of actor.
`final JsonField<String>`	`_cancellationKey()`	Returns the raw JSON value of cancellationKey.
`final JsonField<WorkflowTriggerParams.Data>`	`_data()`	Returns the raw JSON value of data.
`final JsonField<InlineTenantRequest>`	`_tenant()`	Returns the raw JSON value of tenant.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`
`final QueryParams`	`_additionalQueryParams()`
`final WorkflowTriggerParams.Builder`	`toBuilder()`
`final WorkflowTriggerParams.Body`	`_body()`
`final String`	`_pathParam(Integer index)`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static WorkflowTriggerParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of WorkflowTriggerParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - key
```
 final Optional<String> key()
```
  - recipients
```
 final List<RecipientRequest> recipients()
```
    The recipients to trigger the workflow for. Can inline identify users, objects, or use a list of user IDs. Limited to 1,000 recipients.
  - actor
```
 final Optional<RecipientRequest> actor()
```
    Specifies a recipient in a request. This can either be a user identifier (string), an inline user request (object), or an inline object request, which is determined by the presence of a collection property.
  - cancellationKey
```
 final Optional<String> cancellationKey()
```
    An optional key that is used to reference a specific workflow trigger request when issuing a /send-notifications/canceling-workflows request. Must be provided while triggering a workflow in order to enable subsequent cancellation. Should be unique across trigger requests to avoid unintentional cancellations.
  - data
```
 final Optional<WorkflowTriggerParams.Data> data()
```
    An optional map of data to pass into the workflow execution.
  - tenant
```
 final Optional<InlineTenantRequest> tenant()
```
    An request to set a tenant inline.
  - _recipients
```
 final JsonField<List<RecipientRequest>> _recipients()
```
    Returns the raw JSON value of recipients.
    Unlike recipients, this method doesn't throw if the JSON field has an unexpected type.
  - _actor
```
 final JsonField<RecipientRequest> _actor()
```
    Returns the raw JSON value of actor.
    Unlike actor, this method doesn't throw if the JSON field has an unexpected type.
  - _cancellationKey
```
 final JsonField<String> _cancellationKey()
```
    Returns the raw JSON value of cancellationKey.
    Unlike cancellationKey, this method doesn't throw if the JSON field has an unexpected type.
  - _data
```
 final JsonField<WorkflowTriggerParams.Data> _data()
```
    Returns the raw JSON value of data.
    Unlike data, this method doesn't throw if the JSON field has an unexpected type.
  - _tenant
```
 final JsonField<InlineTenantRequest> _tenant()
```
    Returns the raw JSON value of tenant.
    Unlike tenant, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
  - toBuilder
```
 final WorkflowTriggerParams.Builder toBuilder()
```
  - _body
```
 final WorkflowTriggerParams.Body _body()
```
  - _pathParam
```
 final String _pathParam(Integer index)
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static WorkflowTriggerParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of WorkflowTriggerParams.
    The following fields are required:
    .recipients()

Class WorkflowTriggerParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

key

recipients

actor

cancellationKey

data

tenant

_recipients

_actor

_cancellationKey

_data

_tenant

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_pathParam

_headers

_queryParams

equals

hashCode

toString

builder