Validate Webhook Auth with HTTP / Webhook API on New Contact Created from Google Contacts API

Pipedream makes it easy to connect APIs for HTTP / Webhook, Google Contacts and 2,200+ other apps remarkably fast.

Trigger workflow on

New Contact Created from the Google Contacts API

Next, do this

Validate Webhook Auth with the HTTP / Webhook API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Google Contacts trigger and HTTP / Webhook action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Contact Created trigger
1. Connect your Google Contacts account
2. Configure timer
Configure the Validate Webhook Auth action
1. Connect your HTTP / Webhook account
2. Configure Authorization Value to Authenticate
3. Configure Return Error to Webhook Caller
4. Select a Authorization Type
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Contact Created on Google Contacts

Description:Emit new event when a new contact is created. [See the documentation](https://developers.google.com/people/api/rest/v1/people.connections/list)

Version:0.0.2

Key:google_contacts-contact-created

View on GitHub

Google Contacts Overview#

The Google Contacts API allows you to integrate your contact data with custom applications, enabling you to sync, manage, and leverage your contact list for a variety of functions. Through Pipedream, you can seamlessly connect the Google Contacts API to various other services, streamlining contact management tasks such as syncing contact details across platforms, automating outreach or follow-ups, and gathering insights from contact interactions.

Trigger Code#

import common from "../common/common.mjs";
import constants from "../../common/constants.mjs";

export default {
  ...common,
  key: "google_contacts-contact-created",
  name: "New Contact Created",
  description: "Emit new event when a new contact is created. [See the documentation](https://developers.google.com/people/api/rest/v1/people.connections/list)",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    async getEvents({
      client, params = {}, pageSize = constants.DEFAULT_PAGE_SIZE,
    }) {
      const {
        connections, nextPageToken,
      } = await this.googleContacts.listContacts(client, {
        pageSize,
        ...params,
      });
      return {
        events: connections,
        nextPageToken,
      };
    },
    getParams() {
      return {
        resourceName: constants.RESOURCE_NAME,
        personFields: constants.FIELD_OPTIONS.join(),
        sortOrder: "LAST_MODIFIED_DESCENDING",
      };
    },
    getTs(contact) {
      return Date.parse(contact.metadata.sources[0].updateTime);
    },
    generateMeta(contact) {
      return {
        id: contact.resourceName,
        summary: contact.names[0].displayName,
        ts: this.getTs(contact),
      };
    },
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Google Contacts	`googleContacts`	`app`	This component uses the Google Contacts app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

Google Contacts uses OAuth authentication. When you connect your Google Contacts account, Pipedream will open a popup window where you can sign into Google Contacts and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Google Contacts API.

Pipedream requests the following authorization scopes when you connect your account:

profileemailhttps://www.googleapis.com/auth/contacts.readonlyhttps://www.googleapis.com/auth/contactshttps://www.googleapis.com/auth/contacts.other.readonly

About Google Contacts#

Google Contacts is a contact management service developed by Google. This service is backed by the Google People API.

Action#

Validate Webhook Auth on HTTP / Webhook

Description:Require authorization for incoming HTTP webhook requests. Make sure to configure the HTTP trigger to "Return a custom response from your workflow".

Version:0.0.3

Key:http-validate-webhook-auth

View on GitHub

HTTP / Webhook Overview#

Build, test, and send HTTP requests without code using your Pipedream workflows. The HTTP / Webhook action is a tool to build HTTP requests with a Postman-like graphical interface.

Point and click HTTP requests

Define the target URL, HTTP verb, headers, query parameters, and payload body without writing custom code.

$A screenshot of Pipedream's HTTP Request Configuration interface with a GET request type selected. The request URL is set to 'https://api.openai.com/v1/models'. The 'Auth' tab is highlighted, indicating that authentication is required for this request. In the headers section, there are two headers configured: 'User-Agent' is set to 'pipedream/1', and 'Authorization' is set to 'Bearer {{openai_api_key}}', showing how the OpenAI account's API key is dynamically inserted into the headers to handle authentication automatically.$

Here's an example workflow that uses the HTTP / Webhook action to send an authenticated API request to OpenAI.

Focus on integrating, not authenticating

This action can also use your connected accounts with third-party APIs. Selecting an integrated app will automatically update the request’s headers to authenticate with the app properly, and even inject your token dynamically.

Pipedream integrates with thousands of APIs, but if you can’t find a Pipedream integration simply use Environment Variables in your request headers to authenticate with.

Compatible with no code actions or Node.js and Python

The HTTP/Webhook action exports HTTP response data for use in subsequent workflow steps, enabling easy data transformation, further API calls, database storage, and more.

Response data is available for both coded (Node.js, Python) and no-code steps within your workflow.

Action Code#

import http from "../../http.app.mjs";

export default {
  name: "Validate Webhook Auth",
  version: "0.0.3",
  key: "http-validate-webhook-auth",
  description: "Require authorization for incoming HTTP webhook requests. Make sure to configure the HTTP trigger to \"Return a custom response from your workflow\".",
  type: "action",
  props: {
    http,
    authInput: {
      type: "string",
      label: "Authorization Value to Authenticate",
      description: "Select the location of the authorization value to check. For example, if you're looking for a Bearer token on the inbound webhook request, set this to `{{steps.trigger.event.body.headers.authorization}}`.",
      default: "{{steps.trigger.event.headers.authorization}}",
    },
    customResponse: {
      type: "boolean",
      label: "Return Error to Webhook Caller",
      description: "If `True`, returns a `401: Invalid credentials` error in the case of invalid authorization. **Make sure to configure the HTTP trigger to \"Return a custom response from your workflow\"**. If `False`, does not return a custom response in the case of invalid auth.",
      default: true,
    },
    authType: {
      type: "string",
      label: "Authorization Type",
      description: "Select the Authorization Type for the incoming webhook.",
      reloadProps: true,
      options: [
        {
          label: "Basic Auth",
          value: "basic",
        },
        {
          label: "Bearer Auth",
          value: "bearer",
        },
        {
          label: "Key-Based Auth",
          value: "key",
        },
      ],
    },
  },
  async additionalProps() {
    const props = {};
    switch (this.authType) {
    case "basic":
      props.basicAuthUsername = {
        type: "string",
        label: "Username",
        description: "Enter your username or reference an environment variable. For example, `{{process.env.username}}`.",
      };
      props.basicAuthPassword = {
        type: "string",
        label: "Password",
        description: "Enter your password or reference an environment variable. For example, `{{process.env.password}}`.",
        secret: true,
      };
      break;
    case "bearer":
      props.bearer = {
        type: "string",
        label: "Bearer Token",
        description: "Enter your Bearer Token  or reference an environment variable. For example, `{{process.env.token}}`. **Make sure to include any prepended values**, like `Bearer` for example.",
      };
      break;
    case "key":
      props.key = {
        type: "string",
        label: "API Key",
        description: "Enter your API Key or reference an environment variable. For example, `{{process.env.api_key}}`.",
        secret: true,
      };
      break;
    default:
    }
    return props;
  },
  async run({ $ }) {
    const authType = this.authType;
    const authInput = this.authInput;
    let basicString = "";
    if (authType === "basic") {
      const un = this.basicAuthUsername;
      const pw = this.basicAuthPassword;
      const str = `${un}:${pw}`;
      const buff = Buffer.from(str, "utf-8");
      basicString = `Basic ${buff.toString("base64")}`;
    }
    const authValue = this.bearer ?? this.key ?? basicString;
    if (authInput !== authValue) {
      if (this.customResponse) {
        await $.respond({
          status: 401,
          headers: {},
          body: "Invalid credentials",
        });
      }
      return $.flow.exit("Invalid credentials");
    }
    $.export("$summary", "HTTP request successfully authenticated");
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.
Authorization Value to Authenticate	`authInput`	`string`	Select the location of the authorization value to check. For example, if you're looking for a Bearer token on the inbound webhook request, set this to `{{steps.trigger.event.body.headers.authorization}}`.
Return Error to Webhook Caller	`customResponse`	`boolean`	If `True`, returns a `401: Invalid credentials` error in the case of invalid authorization. Make sure to configure the HTTP trigger to "Return a custom response from your workflow". If `False`, does not return a custom response in the case of invalid auth.
Authorization Type	`authType`	`string`	Select a value from the drop down menu:`{ "label": "Basic Auth", "value": "basic" }{ "label": "Bearer Auth", "value": "bearer" }{ "label": "Key-Based Auth", "value": "key" }`