Send Conversion Event with LinkedIn Ads API on New Transaction Created from Ramp API

Pipedream makes it easy to connect APIs for LinkedIn Ads, Ramp and 3,000+ other apps remarkably fast.

Trigger workflow on

New Transaction Created from the Ramp API

Next, do this

Send Conversion Event with the LinkedIn Ads 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 Ramp trigger and LinkedIn Ads action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Transaction Created trigger
1. Connect your Ramp account
2. Configure timer
3. Optional- Select a Department ID
4. Optional- Select a Location ID
Configure the Send Conversion Event action
1. Connect your LinkedIn Ads account
2. Select a Ad Account Id
3. Select a Conversion ID
4. Configure Conversion Happened At
5. Configure Email
6. Configure First Name
7. Configure Last Name
8. Configure Conversion Value Currency Code
9. Configure Conversion Value Amount
10. Optional- Configure Company Name
11. Optional- Configure Title
12. Optional- Configure Country Code
13. Optional- Configure Event ID
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 Transaction Created on Ramp

Description:Emit new event for each new transaction created in Ramp.

Version:0.0.2

Key:ramp-new-transaction-created

View on GitHub

Ramp Overview#

The Ramp API provides programmatic access to financial and accounting functionalities, allowing for the management of company cards, transactions, and reporting. By leveraging the Ramp API within Pipedream, you can automate intricate finance operations, synchronize transaction data with accounting software, trigger notifications based on spending activities, and analyze financial data in real-time, integrating with other services for enhanced financial workflows.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "ramp-new-transaction-created",
  name: "New Transaction Created",
  description: "Emit new event for each new transaction created in Ramp.",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    departmentId: {
      propDefinition: [
        common.props.ramp,
        "departmentId",
      ],
    },
    locationId: {
      propDefinition: [
        common.props.ramp,
        "locationId",
      ],
    },
  },
  methods: {
    ...common.methods,
    _getLatestTransactionId() {
      return this.db.get("latestTransactionId");
    },
    _setLatestTransactionId(id) {
      this.db.set("latestTransactionId", id);
    },
    getResourceFn() {
      return this.ramp.listTransactions;
    },
    getParams() {
      const latestTransactionId = this._getLatestTransactionId();
      const params = {
        order_by_date_asc: true,
        department_id: this.departmentId,
        location_id: this.locationId,
      };
      if (latestTransactionId) {
        params.start = latestTransactionId;
      }
      return params;
    },
    generateMeta(transaction) {
      return {
        id: transaction.id,
        summary: `New Transaction ID: ${transaction.id}`,
        ts: Date.parse(transaction.user_transaction_time),
      };
    },
    emitResults(results, max) {
      if (max && results.length > max) {
        results = results.slice(-1 * max);
      }
      this._setLatestTransactionId(results[results.length - 1].id);
      results.reverse().forEach((transaction) => {
        const meta = this.generateMeta(transaction);
        this.$emit(transaction, meta);
      });
    },
  },
  sampleEmit,
};

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
Ramp	`ramp`	`app`	This component uses the Ramp app.
	`timer`	`$.interface.timer`
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Department ID	`departmentId`	`string`	Select a value from the drop down menu.
Location ID	`locationId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

transactions:readcards:readcards:writespend_programs:readspend_programs:writeusers:readusers:writelocations:readlocations:writelimits:readlimits:writedepartments:readdepartments:writebusiness:readreceipts:readtransfers:readvendors:readmerchants:readaccounting:readreceipts:writevendors:writeentities:readbills:write

About Ramp#

The Corporate Card That Helps You Spend Less

Action#

Send Conversion Event on LinkedIn Ads

Description:Sends a conversion event to LinkedIn Ads. [See the documentation](https://learn.microsoft.com/en-us/linkedin/marketing/integrations/ads-reporting/conversions-api?view=li-lms-2024-01&tabs=http#streaming-conversion-events)

Version:0.0.6

Key:linkedin_ads-send-conversion-event

View on GitHub

LinkedIn Ads Overview#

The LinkedIn Ads API on Pipedream enables you to automate and integrate your LinkedIn advertising efforts with other services. Fetch campaign data, manage ad accounts, or automate ad creation and adjustments. With Pipedream, you can trigger workflows with HTTP requests, emails, and on a schedule, and connect to thousands of other apps with minimal effort.

Action Code#

import { createHash } from "crypto";
import app from "../../linkedin_ads.app.mjs";

export default {
  key: "linkedin_ads-send-conversion-event",
  name: "Send Conversion Event",
  description: "Sends a conversion event to LinkedIn Ads. [See the documentation](https://learn.microsoft.com/en-us/linkedin/marketing/integrations/ads-reporting/conversions-api?view=li-lms-2024-01&tabs=http#streaming-conversion-events)",
  version: "0.0.6",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    app,
    adAccountId: {
      propDefinition: [
        app,
        "adAccountId",
      ],
    },
    conversionId: {
      propDefinition: [
        app,
        "conversionId",
        ({ adAccountId }) => ({
          adAccountId,
        }),
      ],
    },
    conversionHappenedAt: {
      type: "string",
      label: "Conversion Happened At",
      description: "Epoch timestamp in milliseconds at which the conversion event happened. Note: If your source records conversion timestamp in seconds, please insert 000 at the end to transform it to milliseconds. Eg. `1590739275000`.",
    },
    email: {
      type: "string",
      label: "Email",
      description: "Email address of the contact associated with the conversion event which needs to be in SHA256 format, a HEX encoded string with a maximum length of 64 characters. Eg. `test@example.com`.",
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "The first name of the contact to match the conversion.",
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "The last name of the contact to match the conversion.",
    },
    conversionValueCurrencyCode: {
      type: "string",
      label: "Conversion Value Currency Code",
      description: "The currency code of the conversion value in ISO format. Eg. `USD`.",
    },
    conversionValueAmount: {
      type: "string",
      label: "Conversion Value Amount",
      description: "The value of the conversion in decimal string. If you set this field, you must also set in the **Conversion Value Currency Code** field. Eg. `100.05`.",
    },
    companyName: {
      type: "string",
      label: "Company Name",
      description: "A plain text string representing the company of the contact to match.",
      optional: true,
    },
    title: {
      type: "string",
      label: "Title",
      description: "A plain text string representing the title name of the contact to match. Eg. `Software Engineer`.",
      optional: true,
    },
    countryCode: {
      type: "string",
      label: "Country Code",
      description: "An ISO standardized [two letter country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) representing the country of the contact to match. Eg. `US`.",
      optional: true,
    },
    eventId: {
      type: "string",
      label: "Event ID",
      description: "The unique id generated by advertisers to indicate each event. This field is used for [deduplication](https://learn.microsoft.com/en-us/linkedin/marketing/conversions/deduplication?view=li-lms-2024-01).",
      optional: true,
    },
  },
  methods: {
    emailToSha256(email) {
      return createHash("sha256")
        .update(email)
        .digest("hex");
    },
    sendConversionEvent(args = {}) {
      return this.app._makeRequest({
        debug: true,
        method: "POST",
        path: "/conversionEvents",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      app,
      emailToSha256,
      sendConversionEvent,
      conversionId,
      conversionHappenedAt,
      conversionValueCurrencyCode,
      conversionValueAmount,
      email,
      firstName,
      lastName,
      companyName,
      title,
      countryCode,
      eventId,
    } = this;

    await sendConversionEvent({
      $,
      data: {
        conversion: app.getConversionUrn(conversionId),
        conversionHappenedAt: Number(conversionHappenedAt),
        conversionValue: {
          currencyCode: conversionValueCurrencyCode,
          amount: conversionValueAmount,
        },
        user: {
          userIds: [
            {
              idType: "SHA256_EMAIL",
              idValue: emailToSha256(email),
            },
          ],
          userInfo: {
            firstName,
            lastName,
            companyName,
            title,
            countryCode,
          },
        },
        eventId,
      },
    });

    $.export("$summary", "Successfully sent conversion event to LinkedIn Ads");

    return {
      success: true,
    };
  },
};

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
LinkedIn Ads	`app`	`app`	This component uses the LinkedIn Ads app.
Ad Account Id	`adAccountId`	`string`	Select a value from the drop down menu.
Conversion ID	`conversionId`	`string`	Select a value from the drop down menu.
Conversion Happened At	`conversionHappenedAt`	`string`	Epoch timestamp in milliseconds at which the conversion event happened. Note: If your source records conversion timestamp in seconds, please insert 000 at the end to transform it to milliseconds. Eg. `1590739275000`.
Email	`email`	`string`	Email address of the contact associated with the conversion event which needs to be in SHA256 format, a HEX encoded string with a maximum length of 64 characters. Eg. `test@example.com`.
First Name	`firstName`	`string`	The first name of the contact to match the conversion.
Last Name	`lastName`	`string`	The last name of the contact to match the conversion.
Conversion Value Currency Code	`conversionValueCurrencyCode`	`string`	The currency code of the conversion value in ISO format. Eg. `USD`.
Conversion Value Amount	`conversionValueAmount`	`string`	The value of the conversion in decimal string. If you set this field, you must also set in the Conversion Value Currency Code field. Eg. `100.05`.
Company Name	`companyName`	`string`	A plain text string representing the company of the contact to match.
Title	`title`	`string`	A plain text string representing the title name of the contact to match. Eg. `Software Engineer`.
Country Code	`countryCode`	`string`	An ISO standardized two letter country code representing the country of the contact to match. Eg. `US`.
Event ID	`eventId`	`string`	The unique id generated by advertisers to indicate each event. This field is used for deduplication

Action Authentication#

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

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

r_ads_reportingrw_adsr_adsr_basicprofiler_marketing_leadgen_automationr_ads_leadgen_automationr_organization_adminrw_conversionsr_events