Knock.Workflows (Knock v0.2.0) View Source
Functions for interacting with Knock notify resources.
Link to this section Summary
Functions
Cancels the workflow with the given cancellation key.
Executes a notify call for the workflow with the given key.
Link to this section Functions
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 user ids to cancel the notify for
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.