AgentPushKit

The complete Agent Push Kit REST API. Application event ingestion uses an organization key beginning with `apk_`. Authenticated user operations accept either an Agent Push Kit login JWT or an agent access token beginning with `apt_`.

Building

To install the required dependencies and to build the elixir project, run:

mix local.hex --force
mix do deps.get, compile

Installation

If available in Hex, the package can be installed by adding agent_push_kit to your list of dependencies in mix.exs:

def deps do
  [{:agent_push_kit, "~> 0.1.0"}]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at [https://hexdocs.pm/agent_push_kit][docs].

Configuration

You can override the URL of your server (e.g. if you have a separate development and production server in your configuration files).

config :agent_push_kit, base_url: "https://api.chatdna.co/agent-push-kit/v1"

Multiple clients for the same API with different URLs can be created passing different base_urls when calling AgentPushKit.Connection.new/1:

client = AgentPushKit.Connection.new(base_url: "https://api.chatdna.co/agent-push-kit/v1")