Create Campaign with CleverTap API on New Events (Instant) from Twilio SendGrid API

Pipedream makes it easy to connect APIs for CleverTap, Twilio SendGrid and 2,800+ other apps remarkably fast.

Trigger workflow on

New Events (Instant) from the Twilio SendGrid API

Next, do this

Create Campaign with the CleverTap 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 Twilio SendGrid trigger and CleverTap action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Events (Instant) trigger
1. Connect your Twilio SendGrid account
2. Select one or more Event Types
Configure the Create Campaign action
1. Connect your CleverTap account
2. Configure Campaign Name
3. Select a Target Mode
4. Optional- Configure Where
5. Optional- Configure Content
6. Optional- Configure Respect Frequency Caps
7. Optional- Configure Estimate Only
8. Optional- Configure Conversion Goal
9. Optional- Select a Time To Live Type
10. Optional- Configure Time To Live Value
11. Optional- Configure Webhook Endpoint Name
12. Optional- Configure Webhook Fields
13. Optional- Configure Webhook Key Value
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 Events (Instant) on Twilio SendGrid

Description:Emit new event when any of the specified SendGrid events is received

Version:0.0.7

Key:sendgrid-events

View on GitHub

Twilio SendGrid Overview#

The Twilio SendGrid API opens up a world of possibilities for email automation, enabling you to send emails efficiently and track their performance. With this API, you can programmatically create and send personalized email campaigns, manage contacts, and parse inbound emails for data extraction. When you harness the power of Pipedream, you can connect SendGrid to hundreds of other apps to automate workflows, such as triggering email notifications based on specific actions, syncing email stats with your analytics, or handling incoming emails to create tasks or tickets.

Trigger Code#

import common from "../common/http-based.mjs";
import deliveryEventTypes from "./delivery-event-types.mjs";
import engagementEventTypes from "./engagement-event-types.mjs";

export default {
  ...common,
  key: "sendgrid-events",
  name: "New Events (Instant)",
  description: "Emit new event when any of the specified SendGrid events is received",
  version: "0.0.7",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    eventTypes: {
      type: "string[]",
      label: "Event Types",
      description: "The type of events to listen to",
      options(context) {
        const { page } = context;
        if (page !== 0) {
          return {
            options: [],
          };
        }

        const options = [
          ...deliveryEventTypes,
          ...engagementEventTypes,
        ];
        return {
          options,
        };
      },
    },
  },
  methods: {
    ...common.methods,
    baseWebhookSettings() {
      // The list of events that a webhook can listen to. This method returns an
      // exhaustive list of all such flags disabled, and each event source can
      // then override the flags that are relevant to the event they handle.
      //
      // See the docs for more information:
      // https://sendgrid.com/docs/api-reference/
      const eventTypesData = [
        ...deliveryEventTypes,
        ...engagementEventTypes,
      ];
      return eventTypesData.reduce((accum, eventTypeData) => ({
        ...accum,
        [eventTypeData.value]: false,
      }), {});
    },
    webhookEventFlags() {
      return this.eventTypes.reduce((accum, eventType) => ({
        ...accum,
        [eventType]: true,
      }), {});
    },
    generateMeta(data) {
      const {
        event: eventType,
        sg_event_id: id,
        timestamp: ts,
      } = data;
      const summary = `New event: ${eventType}`;
      return {
        id,
        summary,
        ts,
      };
    },
  },
};

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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid 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.
Event Types	`eventTypes`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

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

About Twilio SendGrid#

Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.

Action#

Create Campaign on CleverTap

Description:Create a campaign. [See the documentation](https://developer.clevertap.com/docs/create-campaign-api)

Version:0.0.1

Key:clevertap-create-campaign

View on GitHub

CleverTap Overview#

CleverTap offers a powerful suite of tools for user engagement and analytics that can help you track user activities, segment users, and run targeted campaigns. Integrating Clevertap with Pipedream allows you to automate interactions with users, synchronize data across platforms, and create personalized marketing strategies. You can trigger workflows with real-time events, analyze user behavior, and leverage Pipedream's ability to connect to hundreds of other apps to enrich and act on your CleverTap data.

Action Code#

import app from "../../clevertap.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "clevertap-create-campaign",
  name: "Create Campaign",
  description: "Create a campaign. [See the documentation](https://developer.clevertap.com/docs/create-campaign-api)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    name: {
      type: "string",
      label: "Campaign Name",
      description: "The name of your campaign shown in the CleverTap dashboard.",
    },
    targetMode: {
      type: "string",
      label: "Target Mode",
      description: "The type of campaign to create",
      reloadProps: true,
      options: [
        {
          label: "Web Push Notification",
          value: "webpush",
        },
        {
          label: "Mobile Push Notification",
          value: "push",
        },
        {
          label: "Email",
          value: "email",
        },
        {
          label: "Webhooks",
          value: "webhook",
        },
      ],
    },
    where: {
      type: "object",
      label: "Where",
      optional: true,
      description: `Allows you to filter target base on the user events and profile properties. Omit this parameter to target your entire user base. **Example:**
\`\`\`
{
  "event_name": "Charged",
  "from": 20250101,
  "to": 20250402
}
\`\`\``,
    },
    content: {
      type: "object",
      label: "Content",
      description: `Object that defines the content for your message. **Web Push Notification Example:**
\`\`\`
{
  "title": "Hi!",
  "body": "How are you doing today?",
  "platform_specific": {
    "safari": {
      "deep_link": "https://www.google.com",
      "ttl": 10
    },
    "chrome": {
      "image": "https://www.exampleImage.com",
      "icon": "https://www.exampleIcon.com",
      "deep_link": "http://www.example.com",
      "ttl": 10,
      "require_interaction": true,
      "cta_title1": "title",
      "cta_link1": "http://www.example2.com",
      "cta_iconlink1": "https://www.exampleIcon2.com"
    },
    "firefox": {
      "icon": "https://www.exampleIcon.com",
      "deep_link": "https://www.google.com",
      "ttl": 10
    },
    "kaios": {
      "icon": "https://www.exampleIcon.com",
      "ttl": 10,
      "kaiosKV": {
        "key1": "value1",
        "key2": "value2"
      }
    }
  }
}
\`\`\`\n\n**Mobile Push Notification Example:**
\`\`\`
{
  "title": "Hi!",
  "body": "How are you doing today?",
  "platform_specific": {
    "ios": {
      "mutable-content": "true", 
      "deep_link": "example.com",
      "sound_file": "example.caf",
      "category": "application category//Books",
      "badge_count": 1,
      "Key": "Value_ios"
    },
    "android": {
      "enable_rendermax": true,
      "wzrk_cid": "Marketing",
      "background_image": "http://example.jpg",
      "default_sound": true,
      "deep_link": "example.com",
      "large_icon": "http://example.png",
      "Key": "Value_android",
    }
  }
}
\`\`\`\n\n **Email Example:**
\`\`\`
{
  "subject": "Welcome",
  "body": "<div>Your HTML content for the email</div>",
  "sender_name": "CleverTap"
}
\`\`\``,
      optional: true,
    },
    respectFrequencyCaps: {
      type: "boolean",
      label: "Respect Frequency Caps",
      description: "Set to `false` if you want to override frequency caps and dwell time. Defaults to `true`.",
      optional: true,
    },
    estimateOnly: {
      type: "boolean",
      label: "Estimate Only",
      description: "If this parameter is set to `true`, the request returns an estimated reach of the campaign, which is the number of users who receive the notification when you send it out. Setting this parameter to `true` does not create the campaign. Defaults to `false`.",
      optional: true,
    },
    conversionGoal: {
      type: "object",
      label: "Conversion Goal",
      optional: true,
      description: `Checks the end goal of the campaign for conversion tracking. **Example:**
\`\`\`
{
  "event_name": "Charged",
  "filter_type": {
    "event_property": [
      {
        "property_name": "Items|Book name",
        "operator": "equals",
        "property_value": "book name"
      },
      {
        "property_name": "Amount",
        "operator": "equals",
        "property_value": 3456
      },
      {
        "property_name": "Currency",
        "operator": "equals",
        "property_value": "USD"
      }
    ],
    "first_time": "yes",
    "last_time": "yes",
    "time_of_day": [["21:00","23:00"],["11:34","12:44"],["13:01","13:40"]],
    "day_of_week": [1,7],
    "day_of_month": [1,3,16,31]
  },
  "conversion_time": "1D",
  "revenue_property": "Amount"
}
\`\`\``,
    },
    ttlType: {
      type: "string",
      label: "Time To Live Type",
      description: "This allows setting of time to live for push notifications for android and iOS. The type of time to live. Can be `absolute` or `relative`. Defaults to `absolute`.",
      options: [
        {
          label: "Absolute",
          value: "absolute",
        },
        {
          label: "Relative",
          value: "relative",
        },
      ],
      optional: true,
    },
    ttlValue: {
      type: "integer",
      label: "Time To Live Value",
      description: "This allows setting of time to live for push notifications for android and iOS. The value of the time to live. Can be a number of days, hours, minutes, or seconds.\n- For `relative` ttl, the input is an integer in minutes\n- For `absolute` ttl, the input should be an integer in the `yyyyMMddHHmm` format. Example: `202207200000`",
      optional: true,
    },
    webhookEndpointName: {
      type: "string",
      label: "Webhook Endpoint Name",
      description: "The name of the webhook endpoint to use for the campaign.",
      optional: true,
    },
    webhookFields: {
      type: "string[]",
      label: "Webhook Fields",
      description: "The fields to include in the webhook payload. Can be `profile-attributes`, `tokens`, or `identities`.",
      optional: true,
    },
    webhookKeyValue: {
      type: "object",
      label: "Webhook Key Value",
      description: "The key-value pairs to include in the webhook payload.",
      optional: true,
    },
  },
  additionalProps() {
    if (this.targetMode === "push") {
      return {
        when: {
          type: "object",
          label: "When",
          description: `Allows you to set Date, time and Delivery preferences of the message. **Example:**
\`\`\`
{
  "type": "later",
  "delivery_date_time": ["20230503 15:20"],
  "delivery_timezone": "user",
  "user_timezone_wrap_around": true,
  "dnd": {
    "message_state": "delay",
    "dnd_timezone": "user"
  },
  "campaign_cutoff": "14:20"
}
\`\`\``,
        },
      };
    }

    return {
      when: {
        type: "string",
        label: "When",
        description: "When you want to send out the messages. Valid inputs are `now` (to send the notification right away) or in the format **YYYYMMDD HH:MM** to schedule the messages for a specific date and time in the future. **Example:** `20250717 15:20`",
      },
    };
  },
  async run({ $ }) {
    const {
      app,
      name,
      targetMode,
      when,
      where,
      content,
      respectFrequencyCaps,
      estimateOnly,
      conversionGoal,
      ttlType,
      ttlValue,
      webhookEndpointName,
      webhookFields,
      webhookKeyValue,
    } = this;

    const response = await app.createCampaign({
      $,
      data: {
        name,
        target_mode: targetMode,
        respect_frequency_caps: respectFrequencyCaps,
        estimate_only: estimateOnly,
        when: utils.parseJson(when) || {},
        where: utils.parseJson(where) || {},
        content: utils.parseJson(content) || {},
        ...(conversionGoal
          ? {
            conversion_goal: utils.parseJson(conversionGoal),
          }
          : {}
        ),
        ...(ttlType && ttlValue
          ? {
            ttl: {
              ttl_type: ttlType,
              value: ttlValue,
            },
          }
          : {}
        ),
        ...(webhookEndpointName
          ? {
            webhook_endpoint_name: webhookEndpointName,
          }
          : {}
        ),
        ...(webhookFields
          ? {
            webhook_fields: utils.parseJson(webhookFields),
          }
          : {}
        ),
        ...(webhookKeyValue
          ? {
            webhook_key_value: utils.parseJson(webhookKeyValue),
          }
          : {}
        ),
      },
    });

    $.export("$summary", "Successfully created campaign");

    return response;
  },
};

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
CleverTap	`app`	`app`	This component uses the CleverTap app.
Campaign Name	`name`	`string`	The name of your campaign shown in the CleverTap dashboard.
Target Mode	`targetMode`	`string`	Select a value from the drop down menu:`{ "label": "Web Push Notification", "value": "webpush" }{ "label": "Mobile Push Notification", "value": "push" }{ "label": "Email", "value": "email" }{ "label": "Webhooks", "value": "webhook" }`
Where	`where`	`object`	Allows you to filter target base on the user events and profile properties. Omit this parameter to target your entire user base. Example: `{ "event_name": "Charged", "from": 20250101, "to": 20250402 }`
Content	`content`	`object`	Object that defines the content for your message. Web Push Notification Example: { "title": "Hi!", "body": "How are you doing today?", "platform_specific": { "safari": { "deep_link": "https://www.google.com", "ttl": 10 }, "chrome": { "image": "https://www.exampleImage.com", "icon": "https://www.exampleIcon.com", "deep_link": "http://www.example.com", "ttl": 10, "require_interaction": true, "cta_title1": "title", "cta_link1": "http://www.example2.com", "cta_iconlink1": "https://www.exampleIcon2.com" }, "firefox": { "icon": "https://www.exampleIcon.com", "deep_link": "https://www.google.com", "ttl": 10 }, "kaios": { "icon": "https://www.exampleIcon.com", "ttl": 10, "kaiosKV": { "key1": "value1", "key2": "value2" } } } } Mobile Push Notification Example: `{ "title": "Hi!", "body": "How are you doing today?", "platform_specific": { "ios": { "mutable-content": "true", "deep_link": "example.com", "sound_file": "example.caf", "category": "application category//Books", "badge_count": 1, "Key": "Value_ios" }, "android": { "enable_rendermax": true, "wzrk_cid": "Marketing", "background_image": "http://example.jpg", "default_sound": true, "deep_link": "example.com", "large_icon": "http://example.png", "Key": "Value_android", } } }` Email Example: `{ "subject": "Welcome", "body": "<div>Your HTML content for the email</div>", "sender_name": "CleverTap" }`
Respect Frequency Caps	`respectFrequencyCaps`	`boolean`	Set to `false` if you want to override frequency caps and dwell time. Defaults to `true`.
Estimate Only	`estimateOnly`	`boolean`	If this parameter is set to `true`, the request returns an estimated reach of the campaign, which is the number of users who receive the notification when you send it out. Setting this parameter to `true` does not create the campaign. Defaults to `false`.
Conversion Goal	`conversionGoal`	`object`	Checks the end goal of the campaign for conversion tracking. Example: { "event_name": "Charged", "filter_type": { "event_property": [ { "property_name": "Items\|Book name", "operator": "equals", "property_value": "book name" }, { "property_name": "Amount", "operator": "equals", "property_value": 3456 }, { "property_name": "Currency", "operator": "equals", "property_value": "USD" } ], "first_time": "yes", "last_time": "yes", "time_of_day": [["21:00","23:00"],["11:34","12:44"],["13:01","13:40"]], "day_of_week": [1,7], "day_of_month": [1,3,16,31] }, "conversion_time": "1D", "revenue_property": "Amount" }
Time To Live Type	`ttlType`	`string`	Select a value from the drop down menu:`{ "label": "Absolute", "value": "absolute" }{ "label": "Relative", "value": "relative" }`
Time To Live Value	`ttlValue`	`integer`	This allows setting of time to live for push notifications for android and iOS. The value of the time to live. Can be a number of days, hours, minutes, or seconds. For `relative` ttl, the input is an integer in minutes For `absolute` ttl, the input should be an integer in the `yyyyMMddHHmm` format. Example: `202207200000`
Webhook Endpoint Name	`webhookEndpointName`	`string`	The name of the webhook endpoint to use for the campaign.
Webhook Fields	`webhookFields`	`string[]`	The fields to include in the webhook payload. Can be `profile-attributes`, `tokens`, or `identities`.
Webhook Key Value	`webhookKeyValue`	`object`	The key-value pairs to include in the webhook payload.