Knock v0.4.0

Knock.Workflows (Knock v0.4.0) View Source

Functions for interacting with Knock notify resources.

Link to this section Summary

Functions

cancel(client, key, cancellation_key, properties \\ %{})

Cancels the workflow with the given cancellation key.

trigger(client, key, properties)

Executes a notify call for the workflow with the given key.

Link to this section Functions

Link to this function

cancel(client, key, cancellation_key, properties \\ %{})

View Source

Specs

cancel(Knock.Client.t(), String.t(), String.t(), map()) :: Knock.Api.response()

Cancels the workflow with the given cancellation key.

Can optionally be provided with:

  • recipients: A list of recipients to cancel the notify for
Link to this function

trigger(client, key, properties)

View Source

Specs

trigger(Knock.Client.t(), String.t(), map()) :: Knock.Api.response()

Executes a notify call for the workflow with the given key.

Note: properties must contain at least actor and recipents for the call to be valid.