IronWorker Reference

Quick Start Example

This IronWorker reference documentation will help you navigate the basics

API Reference

Every endpoint, every parameter of our API is at your fingertips.

IronWorker CLI Tool

All the arguments and commands in the IronWorker command line interface, at your disposal.

Configuration

Everything you need to know to make the IronWorker client libraries work they way you want them to.

Worker Environment

Know exactly what environment your workers will be executed in before you deploy them.

Something Missing?

Can't find the information you need here? Our engineers are always available and will be happy to answer questions.

If you are using the deprecated IronWorker NG client (Ruby cli with .worker files), the documentation for that is still available here: http://dev-deprecated.iron.io/worker/. We recommend migrating to the new Docker workflow as it's much easier and more productive to use since you can test locally. The migration process is very simple, just run the commands you see here https://github.com/iron-io/dockerworker/ for your language .