Skip to content

Latest commit

 

History

History
144 lines (66 loc) · 4.27 KB

admin_guide.md

File metadata and controls

144 lines (66 loc) · 4.27 KB

Uhura Messaging

Uhura Admin Guide

This guide contains screenshots of Uhura's admin application.

First, navigate to where you started the Uhura Messaging Server:

Next, click the admin application link.

The default page for Uhura's admin application is the Managers page.

A manager represents the application that manages this Uhura installation.

In our example, Sample - App 1 is this Uhura instance's managing application.

When the Uhura Client application, e.g., Sample - App 1, sends requests to the Uhura Messaging Server for processing, it passes it's Public Token, e.g., 42c50c442ee3ca01378e to identify itself.

Please gnore the {"error"=>"undefined method receiver_sso_id' for :to_s:Symbol"}` error messages you see here. They appear only for the few developers, in their development environment, when they happen to be running RubyMine in debug mode.

In case you're wondering, "Why aren't there any Clearstream Msg Events below?" The answer is, "Because Clearstream waits 30 minutes before processing webhook events." See the bottom of this guide for a screenshot of what this page looks like after 30 minutes has transpired.

Delayed Clearstream Webhook Execution

After waiting 30 minutes, we try the Clearstream Msg Events page again and see that the Clearstream web hook has executed and updated this SMS message's status to SENT

Troubleshooting a Sendgrid Error

Asynchronous Jobs

Uhura has configured Sidekiq to handle asnynchronous jobs in config/application.rb:

class Application < Rails::Application
  # ...
  config.active_job.queue_adapter = :sidekiq
end

Configure Sendgrid Webhooks

Configure Sendgrid webhooks as follows:

Ngrok

The HTTP POST URL is an ngrok address.

Ngrok is useful for development purposes when you need to provide a fully qualified domain name/URL to a service provider like Sendgrid.

Assuming you started your Uhura Rails development server on port 3000, you can configure ngrok as follows:

After ngrok handles a few requests, you'll see a history like this:

License

This project is licensed under the MIT License - See the LICENSE file for details.