[Data] Convert JSON to String with Formatting API on New Transactional Webhook (Instant) from Brevo API

Pipedream makes it easy to connect APIs for Formatting, Brevo and 2,200+ other apps remarkably fast.

Trigger workflow on

New Transactional Webhook (Instant) from the Brevo API

Next, do this

[Data] Convert JSON to String with the Formatting 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 Brevo trigger and Formatting action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Transactional Webhook (Instant) trigger
1. Connect your Brevo account
2. Configure Description
3. Select one or more Events
Configure the [Data] Convert JSON to String action
1. Connect your Formatting account
2. Configure Input
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 Transactional Webhook (Instant) on Brevo

Description:Emit new event when triggered by a transactional event

Version:0.0.1

Key:brevo-transactional-webhook

View on GitHub

Brevo Overview#

The Brevo API lets you automate and integrate your user and access management tasks right within Pipedream. With Brevo's API, you can manage users, groups, permissions, and more, streamlining how you control access to your resources. By crafting workflows on Pipedream, you can connect Brevo with other apps to create custom, automated processes that suit your specific business needs.

Trigger Code#

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

export default {
  ...common,
  key: "brevo-transactional-webhook",
  name: "New Transactional Webhook (Instant)",
  description: "Emit new event when triggered by a transactional event",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    description: {
      type: "string",
      label: "Description",
      description: "Description of the webhook.",
    },
    events: {
      type: "string[]",
      label: "Events",
      description: "Events triggering the webhook.",
      options: options.transactionalEventOptions,
    },
  },
  methods: {
    ...common.methods,
    getEventNames() {
      return this.events;
    },
    getHookDescription() {
      return this.description;
    },
    getEventType() {
      return "transactional";
    },
    generateMeta(body) {
      const meta = {
        ...body,
      };
      return 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
Brevo	`brevo`	`app`	This component uses the Brevo app.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Description	`description`	`string`	Description of the webhook.
Events	`events`	`string[]`	Select a value from the drop down menu:`sentdeliveredhardBouncesoftBounceblockedspaminvaliddeferredclickopeneduniqueOpenedunsubscribed`

Trigger Authentication#

Brevo uses API keys for authentication. When you connect your Brevo account, Pipedream securely stores the keys so you can easily authenticate to Brevo APIs in both code and no-code steps.

About Brevo#

Brevo helps you grow your business. Build customer relationships across email, SMS, chat, and more. Use the tools you need, when you need them.

Action#

[Data] Convert JSON to String on Formatting

Description:Convert an object to a JSON format string

Version:0.0.5

Key:formatting-convert-json-to-string

View on GitHub

Action Code#

import { defineAction } from "@pipedream/types";
import app from "../../app/formatting.app.mjs";
export default defineAction({
    name: "[Data] Convert JSON to String",
    description: "Convert an object to a JSON format string",
    key: "formatting-convert-json-to-string",
    version: "0.0.5",
    type: "action",
    props: {
        app,
        input: {
            label: "Input",
            description: "An object to be serialized to a JSON format string.",
            type: "object",
        },
    },
    async run({ $ }) {
        try {
            const result = JSON.stringify(this.input);
            $.export("$summary", "Successfully convert object to JSON string");
            return result;
        }
        catch (err) {
            throw new Error("Error serializing object to JSON string: " + err.toString());
        }
    },
});