API Key

Updated 5 months ago by Karan

Introduction

The API key is used in running Byteline flows through the Webhook trigger. API Key can be either in the query parameter or in the headers. The API key is a token that gets passed by the client to start the flow.

How to Pass apiKey

You must use a URL query string parameter to pass the API key. The name of the parameter is apiKey. Query parameters are a defined set of parameters attached to the end of a URL. They are extensions of the URL that are used to help define specific content or actions based on the data by a query parameter. Below is an example URL.

URL

https://api.byteline.io/flow/AUfCtaPgFNRART/run?apiKey=RXGqdGhtYTNFABwTSRNJ

To get the URL with the API key, follow these steps:

Step -1: Open Webhook trigger.

Step -2: Click on the Copy to Clipboard button next to the URL to get the URL with the API key.

URL

https://api.byteline.io/flow/iwoIvvWpVZwOHu/run?apiKey=hEQiRKjwBkOSxgTzfPCN

How to Regenerate API Key

Step -1: Click on the Profile icon located at the top-right corner of the Byteline flow designer console.

Step -2: Select Account from the profile drop-down menu.

Step -3: Click on the Copy to Clipboard button to get the API key from the API key textbox to run Byteline flows through form submissions or APIs.

Note: You can click on the show/hide button to show/hide your API key.

Step -4: Click on the Regenerate Key button to regenerate the API key.

Feel free to connect with us for any doubts.


How did we do?