Create a Pin with Pinterest API on Webhook Destination (Instant) from Segment API

Pipedream makes it easy to connect APIs for Pinterest, Segment and 2,700+ other apps remarkably fast.

Trigger workflow on

Webhook Destination (Instant) from the Segment API

Next, do this

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

Select this integration
Configure the Webhook Destination (Instant) trigger
1. Connect your Segment account
2. Select a Workspace
3. Select a Source
4. Configure Name
5. Optional- Configure Trigger
Configure the Create a Pin action
1. Connect your Pinterest account
2. Select a Board ID
3. Optional- Select a Board Section ID
4. Configure Title
5. Optional- Configure Description
6. Optional- Configure Link
7. Optional- Configure Alt. Text
8. Configure Media
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#

Webhook Destination (Instant) on Segment

Description:Send events to a webhook. Requires a Team or Business account.

Version:0.0.2

Key:segment-webhook-destination

View on GitHub

Segment Overview#

The Segment API enables you to collect, manage, and route your customer analytics data to various tools for marketing, analytics, and data warehousing. By harnessing the Segment API on Pipedream, you can automate the ingestion and syncing of user events and properties to multiple destinations, allowing you to create seamless data pipelines without manual intervention. Pipedream's serverless platform empowers you to build custom workflows that react to events in real-time, enrich data, or trigger actions across your tech stack.

Trigger Code#

import segmentApp from "../../segment.app.mjs";

export default {
  key: "segment-webhook-destination",
  name: "Webhook Destination (Instant)",
  description: "Send events to a webhook. Requires a Team or Business account.",
  version: "0.0.2",
  type: "source",
  props: {
    segmentApp,
    db: "$.service.db",
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    workspace: {
      propDefinition: [
        segmentApp,
        "workspace",
      ],
    },
    source: {
      propDefinition: [
        segmentApp,
        "source",
        ({ workspace }) => ({
          workspace,
        }),
      ],
    },
    name: {
      type: "string",
      label: "Name",
      description: "Defines the display name of the Destination",
    },
    trigger: {
      type: "string",
      label: "Trigger",
      description: "Destination FQL Statement. [Filter Query Language](https://segment.com/docs/api/public-api/fql/)",
      optional: true,
      default: "type = \"identify\" or type = \"track\" or type = \"group\"",
    },
  },
  hooks: {
    async activate() {
      const { data } = await this.segmentApp.createDestination({
        data: {
          sourceId: this.source,
          metadataId: await this.findMetadataId(),
          name: this.name,
          enabled: true,
          connection_mode: "UNSPECIFIED",
          settings: {},
        },
      });
      const destinationId = data.destination.id;
      this.setDestinationId(destinationId);

      const response = await this.segmentApp.createDestinationSubscription({
        destination: destinationId,
        data: {
          name: "Pipedream Webhook Subscription",
          trigger: this.trigger,
          actionId: await this.findActionId(destinationId),
          enabled: true,
          settings: {
            method: "POST",
            url: this.http.endpoint,
          },
        },
      });
      const subscriptionId = response.data.destinationSubscription.id;
      this.setSubscriptionId(subscriptionId);
    },
    async deactivate() {
      const destination = this.getDestinationId();
      const subscription = this.getSubscriptionId();
      await this.segmentApp.deleteDestinationSubscription({
        destination,
        subscription,
      });
      await this.segmentApp.deleteDestination({
        destination,
      });
    },
  },
  methods: {
    getDestination() {
      return "actions-webhook";
    },
    setDestinationId(id) {
      this.db.set("destinationId", id);
    },
    getDestinationId() {
      return this.db.get("destinationId");
    },
    setSubscriptionId(id) {
      this.db.set("subscriptionId", id);
    },
    getSubscriptionId() {
      return this.db.get("subscriptionId");
    },
    async findDestinationMetadataId() {
      const params = {
        pagination: {
          count: 200,
        },
      };
      do {
        const {
          data: {
            destinationsCatalog, pagination,
          },
        } = await this.segmentApp.getDestinationsCatalog({
          params,
        });
        const destination = destinationsCatalog.find(({ slug }) => slug === this.getDestination());
        if (destination) {
          return destination.id;
        }
        params.pagination.cursor = pagination?.next;
      } while (params.pagination.cursor);
    },
    async findMetadataId() {
      const destinationMetadataId = await this.findDestinationMetadataId();
      const { data: { destinationMetadata } } =  await this.segmentApp.getDestinationMetadata({
        destinationMetadataId,
      });
      if (!destinationMetadata?.id) {
        throw new Error(`MetadataId for ${this.getDestination()} not found.`);
      }
      return destinationMetadata.id;
    },
    async findActionId(destination) {
      const { data } = await this.segmentApp.getDestination({
        destination,
      });
      return data.destination.metadata.actions[0].id;
    },
  },
  async run(event) {
    this.http.respond({
      status: 200,
    });

    this.$emit(event, {
      id: Date.now(),
      summary: "Received event",
      ts: Date.now(),
    });
  },
};

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
Segment	`segmentApp`	`app`	This component uses the Segment app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Workspace	`workspace`	`string`	Select a value from the drop down menu.
Source	`source`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	Defines the display name of the Destination
Trigger	`trigger`	`string`	Destination FQL Statement. Filter Query Language

Trigger Authentication#

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

Segment's APIs are accessed programmatically using access tokens, as well as write keys.

Access Token

Create access tokens via the Access Management page in your account: https://app.segment.com/{your-workspace-name}/settings/access-management. See "Get a Token" for more details. Please note, that you must be on a Team or Business plan to create an access token.

Write Key

You will also need to find your write key, which is a unique identifier for your Source. To find a write key, you first need to create a non-Cloud Source such as a website, server, or mobile source. (Cloud-sources do not have write keys, as they use a token or key from your account with that service.) Then, in the Source, go to “Settings’, and then go to “API Keys”. See "Locating Your Write Key" for more details.

About Segment#

Customer data platform

Action#

Create a Pin on Pinterest

Description:Create a Pin on a board or board section, [See the docs](https://developers.pinterest.com/docs/api/v5/#operation/pins/create)

Version:0.1.0

Key:pinterest-create-pin

View on GitHub

Pinterest Overview#

The Pinterest API opens a portal to interact programmatically with Pinterest's rich data, including boards, pins, and user information. By leveraging this API on Pipedream, you can automate actions like posting new pins, extracting pin data for analysis, and synchronizing Pinterest content with other platforms. The potential extends to marketing optimization, content management, and audience engagement, all automated and integrated within the Pipedream ecosystem.

Action Code#

import pinterest from "../../pinterest.app.mjs";
import { ConfigurationError } from "@pipedream/platform";
import utils from "../../common/utils.mjs";

export default {
  type: "action",
  key: "pinterest-create-pin",
  version: "0.1.0",
  name: "Create a Pin",
  description: "Create a Pin on a board or board section, [See the docs](https://developers.pinterest.com/docs/api/v5/#operation/pins/create)",
  props: {
    pinterest,
    boardId: {
      propDefinition: [
        pinterest,
        "boardId",
      ],
    },
    boardSectionId: {
      propDefinition: [
        pinterest,
        "boardSectionId",
        (configuredProps) => ({
          boardId: configuredProps.boardId,
        }),
      ],
    },
    title: {
      propDefinition: [
        pinterest,
        "title",
      ],
    },
    description: {
      propDefinition: [
        pinterest,
        "description",
      ],
    },
    link: {
      propDefinition: [
        pinterest,
        "link",
      ],
    },
    altText: {
      propDefinition: [
        pinterest,
        "altText",
      ],
    },
    media: {
      propDefinition: [
        pinterest,
        "media",
      ],
    },
  },
  async run ({ $ }) {
    let mediaSource;
    const media = this.media;
    const fileValidation = utils.isValidFile(media);
    if (fileValidation) {
      mediaSource = utils.getFileMeta(fileValidation);
    } else if (await utils.isValidUrl(media)) {
      mediaSource = utils.getUrlMeta(media);
    } else {
      const downloadedFile = await utils.getUrlResource(media);
      if (!downloadedFile) {
        throw new ConfigurationError("`media` must be a valid file path or a valid URL!");
      } else {
        mediaSource = utils.getFileMeta(downloadedFile.path, downloadedFile.contentType);
      }
    }
    const resp = await this.pinterest.createPin({
      $,
      data: {
        board_id: this.boardId,
        board_section_id: this.boardSectionId,
        title: this.title,
        description: this.description,
        link: this.link,
        alt_text: this.altText,
        media_source: mediaSource,
      },
    });
    $.export("$summary", `Pin with ID:${resp.id} has been created.`);
    return resp;
  },
};

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
Pinterest	`pinterest`	`app`	This component uses the Pinterest app.
Board ID	`boardId`	`string`	Select a value from the drop down menu.
Board Section ID	`boardSectionId`	`string`	Select a value from the drop down menu.
Title	`title`	`string`	Title of the pin
Description	`description`	`string`	Description of the pin
Link	`link`	`string`	Source link
Alt. Text	`altText`	`string`	Alt. text of the pin
Media	`media`	`string`	The media content of the pin, only images are supported currently, please provide an image url or an image file from `/tmp`. To upload a file to `/tmp` folder, please follow the doc here

Action Authentication#

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

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

boards:readboards:read_secretboards:writeboards:write_secretpins:readpins:read_secretpins:writepins:write_secretuser_accounts:read

About Pinterest#

Pinterest is a visual discovery engine for finding ideas like recipes, home and style inspiration, and more.