Integrate the CiviCRM API with the HTTP / Webhook API

Setup the CiviCRM API trigger to run a workflow which integrates with the HTTP / Webhook API. Pipedream's integration platform allows you to integrate CiviCRM and HTTP / Webhook remarkably fast. Free for developers.

Start for free — no credit card required

Watch a demo

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

Popular CiviCRM and HTTP / Webhook Triggers#

New Requests from the HTTP / Webhook API

Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.

Try it

New Requests (Payload Only) from the HTTP / Webhook API

Get a URL and emit the HTTP body as an event on every request

Try it

New event when the content of the URL changes. from the HTTP / Webhook API

Emit new event when the content of the URL changes.

Try it

Popular CiviCRM and HTTP / Webhook Actions#

Send any HTTP Request with the HTTP / Webhook API

Send an HTTP request using any method and URL. Optionally configure query string parameters, headers, and basic auth.

Try it

Send GET Request with the HTTP / Webhook API

Send an HTTP GET request to any URL. Optionally configure query string parameters, headers and basic auth.

Try it

Send POST Request with the HTTP / Webhook API

Send an HTTP POST request to any URL. Optionally configure query string parameters, headers and basic auth.

Try it

Send PUT Request with the HTTP / Webhook API

Send an HTTP PUT request to any URL. Optionally configure query string parameters, headers and basic auth.

Try it

Return HTTP Response with the HTTP / Webhook API

Use with an HTTP trigger that uses "Return a custom response from your workflow" as its HTTP Response

Try it

Overview of CiviCRM#

The CiviCRM API allows interaction with the CiviCRM ecosystem, enabling you to manage contacts, contributions, events, memberships, and more directly via Pipedream. With Pipedream's serverless platform, you can create workflows that automate tasks, sync data across apps, and respond to webhooks. Using Pipedream, you can harness the CiviCRM API to craft custom integrations that trigger actions within CiviCRM or sync data with other tools, without managing infrastructure.

Connect CiviCRM#

import { axios } from "@pipedream/platform"
export default defineComponent({
  props: {
    civicrm: {
      type: "app",
      app: "civicrm",
    }
  },
  async run({steps, $}) {
    const base64 = Buffer.from(this.civicrm.$auth.username+":"+this.civicrm.$auth.password).toString('base64');
    return await axios($, {
      method: "POST",
      url: `https://${this.civicrm.$auth.url}/civicrm/ajax/api4/Contact/get`,
      headers: {
        "X-Civi-Auth": `Basic ${base64}`,
      },
    })
  },
})

Overview of HTTP / Webhook#

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.

Connect HTTP / Webhook#

// To use any npm package on Pipedream, just import it
import axios from "axios"

export default defineComponent({
  async run({ steps, $ }) {
    const { data } = await axios({
      method: "GET",
      url: "https://pokeapi.co/api/v2/pokemon/charizard",
    })
    return data.species
  },
})

Community Posts#

A Look at Pipedream

I'm going to build a workflow that will search Twitter every hour for a keyword. It will take the results, format them nicely, and then email it.

Building a Traffic-Based Workflow in Pipedream

Normally I don't like to blog about stuff that isn't generally available to all, but as it will be available sometime soon, I decided to go ahead anyway. And I built something really cool I want to share so that's another reason to talk about this now!

Start for free — no credit card required

Watch a demo