Our APIs enable you to publish and process events through multiple workflows and action types. This page contains a comprehensive reference for all of our public APIs. For walkthrough documentation please see our main docs site.

To get started, sign up at https://flowbytes.io. This will give you access to the Flowbytes console where you can configure your account and retrieve your credentials needed to authenticate to the API.

To streamline integration we provide client libraries for a number of languages, otherwise you can integrate directly with the API using the HTTP tooling built-in to most modern frameworks.

In order to authenticate with Flowbytes APIs you need to request an OAuth 2.0 Access Token using your Client ID and Secret available from the Flowbytes console.

The following example demonstrates how to do this. To authorize the request, provide your Client ID and Secret in the Authorization header using the Basic Scheme (base_64_encode(your_client_id:your_client_secret)).

curl --location --request POST 'https://auth.flowbytes.io/oauth/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic dGVzdC1hY2Nlc3Mta2V5LWlkOnRlc3QtYWNjZXNzLWtleS1zZWNyZXQ=' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'scope=events:publish'

This will return a Bearer access token in the JSON Web Token (JWT) format which you should use in the Authorization header of any subsequent Flowbytes API requests:

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
  "token_type": "bearer",
  "expires_in": 3600
}

The access token will be valid for the length of time in seconds indicated by the expires_in field. When it expires, you should request a new one. If using one of our client libraries, this will be handled automatically for you.

The Events API enables you to publish events to both inline and user workflows, and check the status of triggered workflow actions.

Just like you, we use webhooks (yes we eat our own dogfood) to inform our clients of important activity in their account. This can enable you to automate certain activities, such as informing your users when one of their workflows has been disabled due to destination server issues.