Specs

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

Batch update messages statuses: seen, read, interacted, archived, unseen, unread, unarchived

Specs

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

Returns information about the message.

Specs

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

Returns a paginated response with message's activities.

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

- trigger_data: filter activities by trigger payload data

Specs

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

Returns information about the message content.

Specs

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

Returns a paginated response with message's events.

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(), Keyword.t()) :: Knock.Api.response()

Returns paginated messages for the provided environment

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

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

Sets status of message: seen, read, archived

Specs

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

Unsets status of message: unseen, unread, unarchived