ex_cogmint v0.0.6 ExCogmint.Config

Configuration for the ExCogmint app.

Provide configuration in your application's config.exs.

Example configuration:

  config :ex_cogmint,
    cogmint_api_key: System.get_env("COGMINT_API_KEY"),
    callback_url: System.get_env("COGMINT_CALLBACK_URL"),
    cogmint_url: System.get_env("COGMINT_URL")

cogmint_api_key: required. The API key for your Cogmint account.

callback_url: optional. Sets the default callback_url on each task created. If your app has a single endpoint for receiving all callbacks from Cogmint it is recommended to set this, or else you need to set it individually on every task creation API call.

cogmint_url: optional. The URL where this app expects to find Cogmint. You should never need to set this.

Link to this section Summary

Functions

Returns the API key.

The default callback URL for tasks created via this API. Cogmint will send webhook events to this URL, such as "task_completed".

Returns a specification to start this module under a supervisor.

Retrieves the default callback (webhook) URL where Cogmint will send webhooks.

Retrieves cogmint_url from config or uses https://www.cogmint.com (default)

Returns the Cogmint server URL. You should never need to change this, but can point this library at any endpoint you want, perhaps to test calls that are sent.

Link to this section Functions

Returns the API key.

The default callback URL for tasks created via this API. Cogmint will send webhook events to this URL, such as "task_completed".

Link to this function

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

get_callback_url()

Retrieves the default callback (webhook) URL where Cogmint will send webhooks.

Link to this function

get_server_url()

Retrieves cogmint_url from config or uses https://www.cogmint.com (default)

Returns the Cogmint server URL. You should never need to change this, but can point this library at any endpoint you want, perhaps to test calls that are sent.