The W3lcome API uses API keys to authenticate requests. You can view and manage your API keys in the W3lcome Dashboard with the admin role.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Authentication to the API is performed via HTTP Basic Auth. Provide your token key as the basic auth value. You do not need to provide a password.

How to get an API key

Be sure to have admin privileges

  1. Login to W3lcome Dashboard‚Äč

  2. Go to Settings on the left menu

  3. Select Integrations on the top menu

  4. Scroll down to API and click Generate a New Token

  5. Add a name to identify this token and click Create

  6. Your token will be something like: ZmJhNDMyNDktMTViYi00NDNjLTg3Y...