Getting Started
How to get started with Portant Developer API
Portant offers a REST API to enable developers to use the power of Portant's Automation Platform in their own systems.
Overview
The developer API is focused around the central resource of a Workflow. There is a variety of CRUD (Create, Read, Update, Delete) to allow the developer to manipulate their workflow objects and subcomponents of the workflow. The current version of the API (v0) relies on the existing webhook sources and outgoing webhook events to run and listen for events from automations respectively. As such, currently all workflows created via the Developer API will be created with a webhook source.
All workflows created via the API will be visible, editable, and usable in the Portant Workflow interface.
Prerequisites
A Portant account - Simply login to the Portant Workflow web app.
A Google account that is connected to Portant - You can ensure you have authorised Portant to access Google Drive via the settings page in Portant Workflow.
A Portant Developer access token - Please contact our integrations team to get started at integrations@portant.co. The access token will be associated with your Portant Account and all requests to the API will be performed as if performed by the associated user.
Accessing the API
The Developer API is discoverable at the following URL:
All requests to these endpoints must contain the Authorization header with the Portant Developer access token you have been provided. For example:
IMPORTANT: Currently all requests to the Developer API must contain a trailing slash:
Next Steps
In the next article we will explore how to create a workflow from scratch via the API.
Last updated