Create Table Record with ServiceNow API on New Matched Traffic Stats from Google Postmaster Tools API

Pipedream makes it easy to connect APIs for ServiceNow, Google Postmaster Tools and 2,000+ other apps remarkably fast.

Trigger workflow on

New Matched Traffic Stats from the Google Postmaster Tools API

Next, do this

Create Table Record with the ServiceNow API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Select this integration
Configure the New Matched Traffic Stats trigger
1. Connect your Google Postmaster Tools account
2. Configure timer
3. Select a Domain Name
4. Configure filterInfo
5. Optional- Configure Match All Filters
6. Optional- Select one or more IP Reputation
7. Optional- Select one or more Domain Reputation
8. Optional- Configure User Reported Spam Ratio Greater Than or Equal To
9. Optional- Configure SPF Success Ratio Less Than
10. Optional- Configure DKIM Success Ratio Less Than
11. Optional- Configure DMARC Success Ratio Less Than
12. Optional- Configure Outbound Encryption Ratio Less Than
13. Optional- Configure Inbound Encryption Ratio Less Than
14. Optional- Configure Error Ratio Greater Than or Equal To
15. Optional- Select a Error Categories
Configure the Create Table Record action
1. Connect your ServiceNow account
2. Configure table_name
3. Configure table_record
4. Optional- Select a api_version
5. Optional- Select a request_format
6. Optional- Select a response_format
7. Optional- Configure x_no_response_body
8. Optional- Select a sysparm_display_value
9. Optional- Configure sysparm_exclude_reference_link
10. Optional- Configure sysparm_fields
11. Optional- Configure sysparm_input_display_value
12. Optional- Select a sysparm_view
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 Matched Traffic Stats on Google Postmaster Tools

Description:Emits a new event when traffic stats match certain criteria. [See the documentation](https://developers.google.com/gmail/postmaster/reference/rest)

Version:0.1.0

Key:google_postmaster_tools_api-new-matched-traffic-stats

View on GitHub

Google Postmaster Tools Overview#

The Google Postmaster Tools API offers insights into the performance and deliverability of emails sent to Gmail users. It provides data on spam rates, feedback loops, delivery errors, and more, allowing senders to optimize email campaigns and enhance inbox placement. In Pipedream, you can harness this data to automate monitoring, analyze sending patterns, and integrate email performance metrics with other services for comprehensive analysis and action.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import googlePostmasterToolsApi from "../../google_postmaster_tools_api.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "google_postmaster_tools_api-new-matched-traffic-stats",
  name: "New Matched Traffic Stats",
  description:
    "Emits a new event when traffic stats match certain criteria. [See the documentation](https://developers.google.com/gmail/postmaster/reference/rest)",
  version: "0.1.0",
  type: "source",
  dedupe: "unique",
  sampleEmit,
  props: {
    googlePostmasterToolsApi,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    domain: {
      propDefinition: [
        googlePostmasterToolsApi,
        "domain",
      ],
    },
    filterInfo: {
      type: "alert",
      alertType: "info",
      content: "By default, events will be emitted when matching **any** of the configured filters. If you want **all** configured filters to be required instead, you can use the `Match All Filters` prop below.",
    },
    matchAllFilters: {
      propDefinition: [
        googlePostmasterToolsApi,
        "matchAllFilters",
      ],
    },
    ipReputation: {
      propDefinition: [
        googlePostmasterToolsApi,
        "ipReputation",
      ],
    },
    domainReputation: {
      propDefinition: [
        googlePostmasterToolsApi,
        "domainReputation",
      ],
    },
    userReportedSpamRatio: {
      propDefinition: [
        googlePostmasterToolsApi,
        "userReportedSpamRatio",
      ],
    },
    spfSuccessRatio: {
      propDefinition: [
        googlePostmasterToolsApi,
        "spfSuccessRatio",
      ],
    },
    dkimSuccessRatio: {
      propDefinition: [
        googlePostmasterToolsApi,
        "dkimSuccessRatio",
      ],
    },
    dmarcSuccessRatio: {
      propDefinition: [
        googlePostmasterToolsApi,
        "dmarcSuccessRatio",
      ],
    },
    outboundEncryptionRatio: {
      propDefinition: [
        googlePostmasterToolsApi,
        "outboundEncryptionRatio",
      ],
    },
    inboundEncryptionRatio: {
      propDefinition: [
        googlePostmasterToolsApi,
        "inboundEncryptionRatio",
      ],
    },
    errorRatio: {
      propDefinition: [
        googlePostmasterToolsApi,
        "errorRatio",
      ],
    },
    errorCategories: {
      propDefinition: [
        googlePostmasterToolsApi,
        "errorCategories",
      ],
    },
  },
  methods: {
    _getSavedItems() {
      return this.db.get("savedItems") ?? [];
    },
    _setSavedItems(value) {
      this.db.set("savedItems", value);
    },
    getDateValues(date) {
      const [
        year,
        month,
        day,
      ] = date.toISOString().split("T")[0].split("-").map((i) => Number(i));
      return {
        year,
        month,
        day,
      };
    },
    async getTrafficStats() {
      const today = new Date();
      const oneDayAgo = new Date(today);
      oneDayAgo.setDate(oneDayAgo.getDate() - 7);
      const endDate = this.getDateValues(today);
      const startDate = this.getDateValues(oneDayAgo);

      return this.googlePostmasterToolsApi.getDomainTrafficStats({
        domainName: this.domain,
        params: {
          "startDate.day": startDate.day,
          "startDate.month": startDate.month,
          "startDate.year": startDate.year,
          "endDate.day": endDate.day,
          "endDate.month": endDate.month,
          "endDate.year": endDate.year,
        },
      });
    },
    filterIpReputation(item) {
      let { ipReputation } = this;
      if (typeof ipReputation === "string")
        ipReputation = ipReputation.split(",");
      if (!ipReputation?.length) return undefined;
      return item.ipReputations.some(
        ({
          reputation, ipCount,
        }) =>
          ipReputation.includes(reputation) && ipCount > 0,
      );
    },
    filterDomainReputation(item) {
      let { domainReputation } = this;
      if (typeof domainReputation === "string")
        domainReputation = domainReputation.split(",");
      if (!domainReputation?.length) return undefined;
      return domainReputation.includes(item.domainReputation);
    },
    filterRatio(prop, value, greaterOrEqual = false) {
      if (prop?.endsWith("%")) prop = Number(prop.slice(0, -1)) / 100;
      const ratio = Number(prop);
      if (isNaN(ratio) || value === undefined) return undefined;
      return greaterOrEqual
        ? value >= ratio
        : value < ratio;
    },
    filterSpamRatio(item) {
      return this.filterRatio(
        this.userReportedSpamRatio,
        item.userReportedSpamRatio,
        true,
      );
    },
    filterSpfSuccessRatio(item) {
      return this.filterRatio(this.spfSuccessRatio, item.spfSuccessRatio);
    },
    filterDkimSuccessRatio(item) {
      return this.filterRatio(this.dkimSuccessRatio, item.dkimSuccessRatio);
    },
    filterDmarcSuccessRatio(item) {
      return this.filterRatio(this.dmarcSuccessRatio, item.dmarcSuccessRatio);
    },
    filterOutboundEncryptionRatio(item) {
      return this.filterRatio(
        this.outboundEncryptionRatio,
        item.outboundEncryptionRatio,
      );
    },
    filterInboundEncryptionRatio(item) {
      return this.filterRatio(
        this.inboundEncryptionRatio,
        item.inboundEncryptionRatio,
      );
    },
    filterErrorRatio(item) {
      const ratio = Number(this.errorRatio);
      if (isNaN(ratio)) return undefined;

      let { errorCategories } = this;
      if (typeof errorCategories === "string")
        errorCategories = errorCategories.split(",");

      return item.deliveryErrors.some(
        ({
          errorType, errorRatio,
        }) =>
          (!errorCategories || errorCategories.includes(errorType)) && errorRatio > ratio,
      );
    },
    matchesCriteria(item) {
      // Filters return undefined if the prop is not set, or true/false otherwise
      // Filters are a logical AND - if any filter returns false, the item is not emitted
      const filters = [
        this.filterIpReputation,
        this.filterDomainReputation,
        this.filterSpamRatio,
        this.filterSpfSuccessRatio,
        this.filterDkimSuccessRatio,
        this.filterDmarcSuccessRatio,
        this.filterOutboundEncryptionRatio,
        this.filterInboundEncryptionRatio,
        this.filterErrorRatio,
      ];

      let hasMatch = false;

      for (let filter of filters) {
        const result = filter(item);
        if (result === true) {
          if (!this.matchAllFilters) return true;
          hasMatch = true;
        } else if (result === false && this.matchAllFilters) {
          return false;
        }
      }

      return hasMatch;
    },
  },
  async run() {
    const savedItems = this._getSavedItems();
    const ts = Date.now();
    const stats = await this.getTrafficStats();
    stats?.trafficStats?.filter(({ name }) => !savedItems.includes(name)).forEach((item) => {
      const id = item.name;
      if (this.matchesCriteria(item)) {
        this.$emit(item, {
          id,
          summary: `Matched Traffic Stats: ${id}`,
          ts,
        });
        savedItems.push(id);
      }
    });
    this._setSavedItems(savedItems);
  },
};

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 Postmaster Tools	`googlePostmasterToolsApi`	`app`	This component uses the Google Postmaster Tools app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Domain Name	`domain`	`string`	Select a value from the drop down menu.
Match All Filters	`matchAllFilters`	`boolean`	If `true`, events will only be emitted if they match all of the selected criteria. The default behavior is matching any of them.
IP Reputation	`ipReputation`	`string[]`	Select a value from the drop down menu:`{ "label": "High", "value": "HIGH" }{ "label": "Medium", "value": "MEDIUM" }{ "label": "Low", "value": "LOW" }{ "label": "Bad", "value": "BAD" }`
Domain Reputation	`domainReputation`	`string[]`	Select a value from the drop down menu:`{ "label": "High", "value": "HIGH" }{ "label": "Medium", "value": "MEDIUM" }{ "label": "Low", "value": "LOW" }{ "label": "Bad", "value": "BAD" }`
User Reported Spam Ratio Greater Than or Equal To	`userReportedSpamRatio`	`string`	Emit events only when the user reported spam ratio is greater than, or equal to, the specified value (can be a percentage, e.g. `10%` or a ratio between 0 and 1, e.g. `0.1`)
SPF Success Ratio Less Than	`spfSuccessRatio`	`string`	Emit events only when the SPF success ratio is less than the specified value (can be a percentage, e.g. `10%` or a ratio between 0 and 1, e.g. `0.1`)
DKIM Success Ratio Less Than	`dkimSuccessRatio`	`string`	Emit events only when the DKIM success ratio is less than the specified value (can be a percentage, e.g. `10%` or a ratio between 0 and 1, e.g. `0.1`)
DMARC Success Ratio Less Than	`dmarcSuccessRatio`	`string`	Emit events only when the DMARC success ratio is less than the specified value (can be a percentage, e.g. `10%` or a ratio between 0 and 1, e.g. `0.1`)
Outbound Encryption Ratio Less Than	`outboundEncryptionRatio`	`string`	Emit events only when the outbound encryption ratio is less than the specified value (can be a percentage, e.g. `10%` or a ratio between 0 and 1, e.g. `0.1`)
Inbound Encryption Ratio Less Than	`inboundEncryptionRatio`	`string`	Emit events only when the inbound encryption ratio is less than the specified value (can be a percentage, e.g. `10%` or a ratio between 0 and 1, e.g. `0.1`)
Error Ratio Greater Than or Equal To	`errorRatio`	`string`	Emit events only when the error ratio (in the specified `Error Categories`, or any if not specified) is greater than, or equal to, the specified value (can be a percentage, e.g. `10%` or a ratio between 0 and 1, e.g. `0.1`)
Error Categories	`errorCategories`	`string`	Select a value from the drop down menu:`{ "value": "RATE_LIMIT_EXCEEDED", "label": "The Domain or IP is sending traffic at a suspiciously high rate, due to which temporary rate limits have been imposed. The limit will be lifted when Gmail is confident enough of the nature of the traffic." }{ "value": "SUSPECTED_SPAM", "label": "The traffic is suspected to be spam, by Gmail, for various reasons." }{ "value": "CONTENT_SPAMMY", "label": "The traffic is suspected to be spammy, specific to the content." }{ "value": "BAD_ATTACHMENT", "label": "Traffic contains attachments not supported by Gmail." }{ "value": "BAD_DMARC_POLICY", "label": "The sender domain has set up a DMARC rejection policy." }{ "value": "LOW_IP_REPUTATION", "label": "The IP reputation of the sending IP is very low." }{ "value": "LOW_DOMAIN_REPUTATION", "label": "The Domain reputation of the sending domain is very low." }{ "value": "IP_IN_RBL", "label": "The IP is listed in one or more public Real-time Blackhole Lists. Work with the RBL to get your IP delisted." }{ "value": "DOMAIN_IN_RBL", "label": "The Domain is listed in one or more public Real-time Blackhole Lists. Work with the RBL to get your domain delisted." }{ "value": "BAD_PTR_RECORD", "label": "The sending IP is missing a PTR record." }`

Trigger Authentication#

Google Postmaster Tools uses OAuth authentication. When you connect your Google Postmaster Tools account, Pipedream will open a popup window where you can sign into Google Postmaster Tools 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 Postmaster Tools API.

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

emailprofilehttps://www.googleapis.com/auth/postmaster.readonly

About Google Postmaster Tools#

Use Postmaster Tools to analyze your email performance, and help Gmail route your messages to the right place

Action#

Create Table Record on ServiceNow

Description:Inserts one record in the specified table.

Version:0.1.1

Key:servicenow-create-table-record

View on GitHub

ServiceNow Overview#

The ServiceNow API lets developers access and manipulate records, manage workflows, and integrate with other services on its IT service management platform. These capabilities support automating tasks, syncing data across platforms, and boosting operational efficiencies.

Action Code#

// legacy_hash_id: a_k6irW7
import { axios } from "@pipedream/platform";

export default {
  key: "servicenow-create-table-record",
  name: "Create Table Record",
  description: "Inserts one record in the specified table.",
  version: "0.1.1",
  type: "action",
  props: {
    servicenow: {
      type: "app",
      app: "servicenow",
    },
    table_name: {
      type: "string",
      description: "The name of the table where the record will be created.",
    },
    table_record: {
      type: "object",
      description: "The table record object. Use name-value pairs for each field of the record.",
    },
    api_version: {
      type: "string",
      description: "API version number. Version numbers identify the endpoint version that a URI accesses. By specifying a version number in your URIs, you can ensure that future updates to the REST API do not negatively impact your integration. Use `lastest` to use the latest REST endpoint for your instance version.",
      optional: true,
      options: [
        "lastest",
        "v1",
        "v2",
      ],
    },
    request_format: {
      type: "string",
      description: "Format of REST request body",
      optional: true,
      options: [
        "application/json",
        "application/xml",
      ],
    },
    response_format: {
      type: "string",
      description: "Format of REST response body.",
      optional: true,
      options: [
        "application/json",
        "application/xml",
      ],
    },
    x_no_response_body: {
      type: "boolean",
      description: "By default, responses include body content detailing the modified record. Set this request header to true to suppress the response body.",
      optional: true,
    },
    sysparm_display_value: {
      type: "string",
      description: "Return field display values (true), actual values (false), or both (all) (default: false).",
      optional: true,
      options: [
        "true",
        "false",
        "all",
      ],
    },
    sysparm_exclude_reference_link: {
      type: "boolean",
      description: "Flag that indicates whether to exclude Table API links for reference fields.\n* `true`: Exclude Table API links for reference fields.\n* `false`: Include Table API links for reference fields.",
      optional: true,
    },
    sysparm_fields: {
      type: "string",
      description: "A comma-separated list of fields to return in the response.",
      optional: true,
    },
    sysparm_input_display_value: {
      type: "boolean",
      description: "Flag that indicates whether to set field values using the display value or the actual value.\n* `true`: Treats input values as display values and they are manipulated so they can be stored properly in the database.\n* `false`: Treats input values as actual values and stored them in the database without manipulation.",
      optional: true,
    },
    sysparm_view: {
      type: "string",
      description: "Render the response according to the specified UI view (overridden by sysparm_fields).",
      optional: true,
      options: [
        "desktop",
        "mobile",
        "both",
      ],
    },
  },
  async run({ $ }) {
  // See the API docs: https://docs.servicenow.com/bundle/paris-application-development/page/integrate/inbound-rest/concept/c_TableAPI.html#table-POST

    if (!this.table_name || !this.table_record) {
      throw new Error("Must provide table_name, and table_record parameters.");
    }

    var apiVersion = "";
    if (this.api_version == "v1" || this.api_version == "v2") {
      apiVersion = this.api_version + "/";
    }

    return await axios($, {
      method: "post",
      url: `https://${this.servicenow.$auth.instance_name}.service-now.com/api/now/${apiVersion}table/${this.table_name}`,
      headers: {
        "Authorization": `Bearer ${this.servicenow.$auth.oauth_access_token}`,
        "Accept": this.request_format || "application/json",
        "Content-Type": this.response_format || "application/json",
        "X-no-response-body": this.x_no_response_body,
      },
      params: {
        sysparm_display_value: this.sysparm_display_value,
        sysparm_exclude_reference_link: this.sysparm_exclude_reference_link,
        sysparm_fields: this.sysparm_fields,
        sysparm_input_display_value: this.sysparm_input_display_value,
        sysparm_view: this.sysparm_view,
      },
      data: this.table_record,
    });
  },
};

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
ServiceNow	`servicenow`	`app`	This component uses the ServiceNow app.
table_name	`table_name`	`string`	The name of the table where the record will be created.
table_record	`table_record`	`object`	The table record object. Use name-value pairs for each field of the record.
api_version	`api_version`	`string`	Select a value from the drop down menu:`lastestv1v2`
request_format	`request_format`	`string`	Select a value from the drop down menu:`application/jsonapplication/xml`
response_format	`response_format`	`string`	Select a value from the drop down menu:`application/jsonapplication/xml`
x_no_response_body	`x_no_response_body`	`boolean`	By default, responses include body content detailing the modified record. Set this request header to true to suppress the response body.
sysparm_display_value	`sysparm_display_value`	`string`	Select a value from the drop down menu:`truefalseall`
sysparm_exclude_reference_link	`sysparm_exclude_reference_link`	`boolean`	Flag that indicates whether to exclude Table API links for reference fields. `true`: Exclude Table API links for reference fields. `false`: Include Table API links for reference fields.
sysparm_fields	`sysparm_fields`	`string`	A comma-separated list of fields to return in the response.
sysparm_input_display_value	`sysparm_input_display_value`	`boolean`	Flag that indicates whether to set field values using the display value or the actual value. `true`: Treats input values as display values and they are manipulated so they can be stored properly in the database. `false`: Treats input values as actual values and stored them in the database without manipulation.
sysparm_view	`sysparm_view`	`string`	Select a value from the drop down menu:`desktopmobileboth`

Action Authentication#

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

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