Specs

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

Adds subscriptions for all recipients passed as arguments

Expected properties:

• recipients: list of recipients to create subscriptions for
• properties: data to be stored at the subscription level for each recipient

Specs

build_ref(String.t(), String.t()) :: ref()

Builds an object reference, which can be used in workflow trigger calls.

Specs

bulk_add_subscriptions(Knock.Client.t(), String.t(), [map()]) ::
  Knock.Api.response()

Creates a bulk operation to create subscriptions for a set of recipients to a set of objects within the given collection.

Each entry in the provided subscriptions list should have the properties:

• id: the id of an object for subscribing
• recipients: a list of recipients to subscribe to the object
• properties (optional): a map of properties to apply to each recipient subscription

Specs

bulk_delete(Knock.Client.t(), String.t(), [String.t()]) :: Knock.Api.response()

Bulk deletes one or more objects in a collection.

Specs

bulk_set(Knock.Client.t(), String.t(), [map()]) :: Knock.Api.response()

Bulk upserts one or more objects in a collection.

Specs

delete(Knock.Client.t(), String.t(), String.t()) :: Knock.Api.response()

Deletes the given object.

Specs

delete_subscriptions(Knock.Client.t(), String.t(), String.t(), %{
  recipients: [String.t() | map()]
}) :: Knock.Api.response()

Delete subscriptions for recipients passed as arguments

Expected properties:

• recipients: list of recipients to create subscriptions for

Specs

get(Knock.Client.t(), String.t(), String.t()) :: Knock.Api.response()

Gets the given object.

Specs

get_all_preferences(Knock.Client.t(), String.t(), String.t()) ::
  Knock.Api.response()

Returns all of the users preference sets

Specs

get_channel_data(Knock.Client.t(), String.t(), String.t(), String.t()) ::
  Knock.Api.response()

Returns channel data for the given channel id.

Specs

get_messages(Knock.Client.t(), String.t(), String.t(), Keyword.t()) ::
  Knock.Api.response()

Returns paginated messages for the given object

Available optional parameters:

#

- page_size: specify size of the page to be returned by the api. (max limit: 50)

- after: after cursor for pagination

- before: before cursor for pagination

- status: list of statuses to filter messages with

- tenant: tenant_id to filter messages with

- channel_id: channel_id to filter messages with

- source: workflow key to filter messages with

- trigger_data: trigger payload to filter messages with

Specs

get_preferences(Knock.Client.t(), String.t(), String.t(), Keyword.t()) ::
  Knock.Api.response()

Returns the preference set for the user.

Specs

get_schedules(Knock.Client.t(), String.t(), String.t(), Keyword.t()) ::
  Knock.Api.response()

Returns paginated schedules for the given object

Available optional parameters:

#

- page_size: specify size of the page to be returned by the api. (max limit: 50)

- after: after cursor for pagination

- before: before cursor for pagination

- tenant: tenant_id to filter messages with

- workflow: workflow key to filter messages with

Specs

get_subscriptions(Knock.Client.t(), String.t(), String.t(), Keyword.t()) ::
  Knock.Api.response()

Returns paginated subscriptions for the given object as recipient

Available optional parameters:

#

- page_size: specify size of the page to be returned by the api. (max limit: 50)

- after: after cursor for pagination

- before: before cursor for pagination

Specs

list(Knock.Client.t(), String.t(), Keyword.t()) :: Knock.Api.response()

Returns paginated list of objects for a collection

Available optional parameters:

#

- page_size: specify size of the page to be returned by the api. (max limit: 50)

- after: after cursor for pagination

- before: before cursor for pagination

Specs

list_subscriptions(Knock.Client.t(), String.t(), String.t(), Keyword.t()) ::
  Knock.Api.response()

Returns paginated subscriptions for the given object

Available optional parameters:

#

- page_size: specify size of the page to be returned by the api. (max limit: 50)

- after: after cursor for pagination

- before: before cursor for pagination

Specs

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

Upserts the given object in the collection with the attrs provided.

Specs

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

Sets the category preferences for the user.

Specs

set_category_preferences(
  Knock.Client.t(),
  String.t(),
  String.t(),
  String.t(),
  map() | boolean(),
  Keyword.t()
) :: Knock.Api.response()

Sets the category preference for the user.

Specs

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

Upserts channel data for the given channel id.

Specs

set_channel_type_preferences(
  Knock.Client.t(),
  String.t(),
  String.t(),
  String.t(),
  boolean(),
  Keyword.t()
) :: Knock.Api.response()

Sets the channel type preference for the user.

Specs

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

Sets the channel type preferences for the user.

Specs

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

Sets an entire preference set for the user. Will overwrite any existing data.

Specs

set_workflow_preferences(
  Knock.Client.t(),
  String.t(),
  String.t(),
  String.t(),
  map() | boolean(),
  Keyword.t()
) :: Knock.Api.response()

Sets the workflow preference for the user.

Specs

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

Sets the workflow preferences for the user.

Specs

unset_channel_data(Knock.Client.t(), String.t(), String.t(), String.t()) ::
  Knock.Api.response()

Unsets the channel data for the given channel id.