Skip to main content
All CollectionsAPI Documentation
Wrk Premium API - Getting Started
Wrk Premium API - Getting Started

Introduction to the Wrk Premium API for Wrkflow, Launch, Launch Activities endpoints

David Li avatar
Written by David Li
Updated over 2 weeks ago

Note: The Wrk Premium API is currently in close beta.
Information in this document can change without notice.

The Wrk Premium API requires elevated access to use.

Introduction

Wrk Premium API gives you the ability to interface with the Wrk's Platform without using the user-interface. The Premium API allows to perform tasks such as building an automation workflow (Wrkflow) and launching it. This offers deep integration possibilities where Wrk can power an application with the vast capabilities of the Wrk's platform.

The API is organized around REST. Our API has predictable resource-oriented URLs, accepts and returns JSON-encoded requests and responses. It uses standard HTTP response codes authentication, and verbs.

You can interact with the API through HTTP requests from any language or via our Python library.

Authentication

The Wrk Premium API uses API keys to authenticate requests. You can view and manage your API keys in your account. Please note that you need elevated access to make use of Wrk Premium API, or authentication will fail. Please contact our Sales team to request an elevated access.

Your API keys carry many privileges, so be sure to keep them secure. Do not share your key publicly. API keys can be revoked if necessary.

All API requests must be made over HTTPS or the calls will fail.


Technical Documentation

Visit this page for the documentation of the Wrk Premium API based on OpenAPI specifications.

Did this answer your question?