Generating API Key

API Key will allow you to integrate Woodpecker with other tools.

API Key is a part of an Add-on API Key and Integrations that will allow you to integrate Woodpecker with other tools. How do I get this add-on »
If you need any help, contact [email protected] »

Why do I need an API key?

To make the “API” term more understandable let us explain that it stands for an application programming interface key. It allows you to connect our or any app with the one you are using in a very direct and internal way. The API key often constitutes both a unique identifier and a secret token for authentication.

If you care for some details about how API works in a nutshell, just imagine that each app is written in a language that may be metaphorically compared to a socket. Now, to be able to communicate with this app, you need a plug-in that will fit. This is what you’ll find here – a set of connectors and potential actions to let your Woodpecker plug into any other app.

If there is some information we forgot to mention, don’t hesitate to let us know! All feedback helps us grow.

Where can I get this?

Log in to Woodpecker and follow the 3 steps below:

1. Log into your Woodpecker account on

2. Go to the Marketplace‘INTEGRATIONS’ → ‘API keys’.

3. Use the green button to ‘CREATE A KEY’.

Image with arrows showing step-by-step how to create an API Key in Woodpecker

4. Your API key is ready. Copy the key to use it.

Image showing icon which user can click to copy API Key to their clipboard

Now you have your API Key ready to use. Great! If you need more than one API key feel free to get it in the same way as described above.

To learn how to get access to Woodpecker API and authorize your requests, you can read our help articles on API 1.0 and API 2.0 »