Add authentication to an event, visitor, or data record function

Event and visitor functions might require authentication to access some service providers, such as Facebook or Google. To add authentication to a function, you must have an account with the service provider.

How it works

When you add authentication to a function, an access token is generated and is displayed in the Advanced tab of the code editor where you give it a name. Access this authentication in your function by passing that name to helper.getAuth().

For example, if you create an authentication with an access token named firebase_cloud_messaging, access that token in your function using helper.getAuth('firebase_cloud_messaging'). This feature is commonly used to set authorization headers when making requests to authenticated endpoints.

Example:

activate(async ({ visitor, helper }) => {
  const response = await fetch(
    "https://fcm.googleapis.com/v1/projects/YOURPROJECT/messages:send",
    {
      method: "POST",
      headers: {
        'Authorization': 'Bearer ' + helper.getAuth('firebase_cloud_messaging'),
        'Content-Type': 'application/json'
      },
      body:body
    }
  );
});

Supported authentication types

The steps for adding an authentication vary depending on the authentication selected. The following sections provide instructions for adding Facebook, Google, API Key, and UID 2.0 authentication.

For information on adding OAauth 2.0 authentication, see Add OAuth 2.0 authentication.

Facebook authentication

You must log in to Facebook before adding a Facebook authentication. To add Facebook authentication, use the following steps:

1. After you create a function, click the Advanced tab.
2. Log in to your Facebook Ad account.
3. Click Assign Authentications.
4. Click +Add Authentication, then select Facebook Authentication, and click Continue.
5. Enter a Name and click Connect to Facebook.
   An authentication token is returned in User Token.
6. Click Add.

Google authentication

To add Google authentication, use the following steps:

1. After you create a function, click the Advanced tab.
2. Click Assign Authentications.
3. Click +Add Authentication, then select Google Authentication, and click Continue.
4. Enter a Name, the Developer Token name, and click Connect to Google.
   An authentication token is returned in User Token.
5. Click Add.

API key authentication

To add an API key authentication, use the following steps:

1. After you create a function, click the Advanced tab.
2. Click Assign Authentications.
3. Click +Add Authentication, then select API Key, and click Continue.
4. Enter a Name for the token, and click Next.
   A unique access token name for the function is generated based on the specified Name.
5. Enter the API Key. After you save and publish, the API Key is obfuscated and no longer visible.
6. [Optional] Enter a host name to whitelist.
7. To add an additional host name to whitelist, click + Add Host Name and enter the name.
8. Click Add.
9. Click Done.

Delete an authentication

Authentications assigned to a function or to a connector cannot be deleted. To delete an authentication, use the following steps:

1. On the Advanced tab, click Assign Authentications.

2. In the menu for the authentication to be deleted, click Delete.
   If the authentication is assigned to a function or a connector, a message is displayed, listing the functions or connectors to which it is assigned. Click Close.

   

   If the authentication is not assigned to a function or to a connector, a confirmation dialog is displayed. Click Delete.