Voyado Engage

Authentication schemes for custom activities

When you configure a custom activity (external API call), the endpoint may require authentication. 

Engage supports the following authentication schemes:

Basic

In the context of an HTTP transaction, basic access authentication is a method for an HTTP user agent (e.g. a web browser) to provide a username and password when making a request. Basic authentication is a simple authentication scheme built into the HTTP protocol. 

The client sends HTTP requests with the Authorization header that contains the word Basic followed by a space and a Base64-encoded string in the format username:password. Voyado will Base64-encode the configured value. 

For example, to authorize as demo:p@55w0rd, the client would send:

Authorization: Basic ZGVtbzpwQDU1dzByZA==

Bearer

Bearer authentication (also called token authentication) is an HTTP authentication scheme that uses a security token called a bearer token. The name “Bearer authentication” can be understood as “give access to the bearer of this token.” 

The bearer token is a cryptic string, usually generated by the server in response to a login request.

Authorization: Bearer <token>

API key

An application programming interface key (API key) is a unique identifier used to authenticate a user, developer, or calling program to an API (the endpoint).

Engage supports using API key as schema when the API key is set up as a part of authorization header. It is not possible to send the API key as its own header value. If the receiving endpoint is set up to receive it directly in the header you will get the response “401 Unauthorized”. More information here.

Authorization: Apikey <token>

Voyado API

This option is used for internal Voyado APIs (for example, custom triggers). It will be added as its own value in the header.

voyadoapi: <Auth credentials>

Article last reviewed

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.