API Authentication

Authentication is a crucial aspect of securing access to various resources, including APIs.

When creating an Action you must choose an authentication method. In the API documentation of the tool you want to connect, you will find what authentication method applies. Usually there is a specific section where the authentication method is explained.

This article will tell you how to set up the different ways of authentication within Watermelon.

❗️

If you want to use a different authentication method, please contact our support team to see what we can do.


No authentication

No authentication means no credentials or keys are required to connect. It's an open-door policy where anyone can access the resource without restrictions.


Basic authentication

Basic authentication involves providing a username and password to access the resource, complete these fields within your custom action in Watermelon.


Authentication via API key

When choosing authentication via API key, you have 2 options: Bearer Authentication and Custom Authentication. Find out the details and differences below:

Bearer Authentication

API key authentication involves providing a token (API key) to access the resource. Within Watermelon, select Bearer under Auth Type and add your Token.

Custom Authentication

Custom authentication allows for a specialized way of identifying yourself, often involving additional information sent alongside the API request in headers or query parameters. These headers or parameters contain special signals or codes that complement your API key, providing further proof of identity.

  • Add to Headers: This method involves including additional information in the headers of the API request. Headers are used to transmit metadata about the request, such as authentication tokens or session identifiers.
  • Add to Query Parameters: Alternatively, you can add extra information to the query parameters of the API request. Query parameters are appended to the URL and are visible in the request's URL string

❗️

Both adding to headers and adding to query parameters have a limit of 10 headers or parameters per request.