Knock.Messages (Knock v0.4.7) View Source
Knock resources for accessing messages
Link to this section Summary
Functions
Returns information about the message.
Returns a paginated response with message's activities.
Returns information about the message content.
Returns a paginated response with message's events.
Returns paginated messages for the provided environment
Link to this section Functions
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:
#