Skip to content

Public API

Isaiah Fisher edited this page Dec 4, 2024 · 1 revision

Basics

The goal of Pneumatic's public API is to enable you to interact with Pneumatic programmatically. Pneumatic offers a standard REST API, essentially a collection of endpoints that you can send standard http requests to(GET, POST, PUT, PATCH). In addition, Pneumatic exposes several webhooks that allows you to subscribe to events in Pneumatic (task completed, workflow started etc.)

Authorization

A valid API key must be included in all requests. You can find your API key on the integrations page:

Screenshot 2024-12-04 at 3 19 12 PM

Entities

The API gives you access to the same entities you deal with via Pneumatic's GUI:

  • Templates
  • Workflows
  • Tasks
  • Users
  • Webhooks