The Outkit Support and Developer Hub

Welcome to the Outkit support and developer hub. Here you'll find comprehensive guides and documentation to help you start working with Outkit as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started     Guides

What is Outkit? How does it work?

The high-level overview

Click to enlarge.

Click to enlarge.

Outkit is a messaging tool for developers. It currently focuses on outgoing email and SMS/text messages. Hence our name - Outkit - which tries to convey that we are a toolkit for outgoing messaging, which we think is pretty accurate. Here are some of its main use cases/advantages:

  • Easily send both emails and SMSes from your SaaS / app / internal tool / script, using our simple unified API
  • Use your favourite provider - Mailgun/Sendgrid/Amazon SES for email, Twilio for SMS (so far)
  • Switch between providers with ease, even per message if you want, without changing any of your application code
  • Full traceability into your messages - view exactly what was sent, and what the provider responded with, both for successful deliveries and failures
  • Searchable archive of messages - easily find the message that your customer is asking about
  • One-click resending of sent messages, optionally modifying the provider, subject, to/from
  • Real-time feed of messages being submitted - watch what happens as it happens
  • Use our templates (and template management), featuring reuse and inheritance from your project and team
  • OR keep your templates (and optionally styles) in version control, as part of your project/product/app, and simply send in their contents as part of the API call
  • Can be used strictly as a renderer and message archive, if you prefer to do the delivery yourself
  • Optional synchronous rendering and/or delivery, if you need to get the result right away
  • Lets your manage styles separately from your HTML/text, but apply them as inline styles at render time - as per best practise for emails
  • Webhooks that notify you when something happens to your messages - deliveries, failures and more

Some other things we are rather proud of:

  • Strong security focus - encrypted backend configurations, signed API requests and much more
  • State of the art architecture - everything about Outkit has been meticulously designed to provide excellent uptime and stellar performance
  • Sophisticated queueing and retry logic, making us the best choice to ensure delivery - even when your backend/provider is unreliable or temporarily down

We could go on, but we hope this is enough to make you give Outkit a try!

How does it work?

Here’s a quick rundown of the flow of a typical Outkit message:

  • You submit messages using our API
  • We save your message in our datastore and enqueue it for rendering
  • Rendering means that we take the data in the message (local variables, to/from/subject etc.) and apply it to the stored template that your specified in your message
  • After rendering, we enqueue it for delivery
  • We then submit the rendered message to the backend you specified (either in the API call or the default for your project)
  • The response from the backend is normalized and stored along with your message

This is one of several flows that messages can take through our system. As you see in the API documentation, we offer unparallelled flexibility to cover most every need you might have as a developer that needs to send messages.

What's Next

Check out our Getting Started guide to get up and running in just a few minutes

Getting Started