Skip to content

Auto-generated documentation for apps #16161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions components/battle_net/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Overview

The Blizzard Battle.net API provides programmatic access to game-related data for Blizzard titles like World of Warcraft, Diablo III, StarCraft II, and others. Through Pipedream, developers can automate interactions with this API to retrieve game statistics, player data, and more. Such integration allows for the creation of custom dashboards, alert systems, or even integrating game data with other services for enhanced user experiences.

# Example Use Cases

- **Automated Player Stats Dashboard**: Trigger a scheduled workflow in Pipedream that fetches player statistics from games like World of Warcraft or Overwatch. Use this data to update a Google Sheets document or a custom dashboard hosted on a service like AWS S3, providing real-time stats tracking for guilds or individual players.

- **Twitch Stream Alerts for Achievements**: Combine Blizzard Battle.net API with Twitch API to send live notifications on Twitch when a streamer achieves something notable in a game like Diablo III. Use Pipedream to monitor the Battle.net API for specific events and then push these alerts as in-stream messages or notifications to viewers, enhancing viewer engagement.

- **Discord Bot for Guild Updates**: Create a Discord bot that uses Pipedream to connect with the Blizzard Battle.net API to pull the latest guild achievements or raid completions. This bot can automatically post these updates in a guild’s Discord server, keeping members informed and engaged with the latest accomplishments.
11 changes: 11 additions & 0 deletions components/email/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Overview

The Email API on Pipedream allows users to automate email operations seamlessly within workflows. By integrating this API, you can manage sending, receiving, and organizing emails directly through Pipedream’s serverless platform. This capability is pivotal for automations that involve alerting, reporting, or any form of communication via email, complemented by easy integration with numerous other apps supported on Pipedream.

# Example Use Cases

- **Automated Customer Support Tickets**: Automatically create and send emails to customers when a new support ticket is created in apps like Zendesk or Jira. Use the Email API to notify support staff or directly reply to customer inquiries, ensuring rapid response times and efficient communication management.

- **Invoice Generation and Distribution**: When a new payment is processed via Stripe, use the Email API to generate and send an invoice email to the customer. This workflow can be enhanced by integrating with a PDF generation tool to attach invoices directly to the email, streamlining the billing process.

- **Daily Sales Reports**: Configure a workflow that aggregates daily sales data from an eCommerce platform like Shopify, formats it into a readable report, and uses the Email API to send this report to stakeholders every morning. This automation ensures that key personnel are always informed with the latest sales figures, enabling timely strategic decisions.
11 changes: 11 additions & 0 deletions components/npm/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Overview

The npm API provides programmatic access to information about npm packages, enabling developers to automate tasks like fetching package details, checking for updates, and managing dependencies. With Pipedream's capabilities, you can integrate this API to set up custom workflows that trigger actions based on package updates, dependencies vulnerabilities, or even automate part of your CI/CD pipeline by ensuring the latest versions of packages are deployed.

# Example Use Cases

- **Automated Dependency Updates Notification**: Create a workflow that monitors specific npm packages for new updates. Whenever a new version of a package is published, Pipedream can trigger a notification to your Slack, sending you a message with the update details. This keeps your projects up-to-date without manually checking for package updates.

- **Vulnerability Monitoring and Alerts**: Set up a workflow that checks your project's dependencies for known vulnerabilities on a regular schedule. If a vulnerability is detected in any of the dependencies, Pipedream can trigger an alert to your email or issue tracker (like Jira), prompting timely updates or patches to secure your project.

- **Package Publication Monitoring for Teams**: For teams managing multiple npm packages, create a workflow that monitors when a new package version is published by your organization. Pipedream can then update a shared Google Sheet with version details, author, and publish date, serving as a changelog for stakeholders or team members to review.
11 changes: 11 additions & 0 deletions components/proposify/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Overview

Proposify is a tool designed to streamline the proposal process for sales teams, allowing users to create, send, and manage proposals efficiently. By leveraging the Proposify API on Pipedream, users can automate interactions between Proposify and other business tools, enhancing workflow automation and data synchronization across platforms. This integration can lead to more timely proposal updates, improved collaboration, and better tracking of proposal statuses and related sales activities.

# Example Use Cases

- **Automate Proposal Follow-Ups**: Set up a workflow on Pipedream where a new proposal status in Proposify triggers sending a follow-up email via SendGrid if the proposal remains unopened for a specific period. This ensures timely follow-ups and increases the chances of proposal acceptance.

- **Sync Proposals with CRM**: Automatically update CRM records in Salesforce whenever a proposal is accepted or declined in Proposify. This workflow keeps sales data synchronized and up-to-date without manual entry, reducing errors and saving time.

- **Proposal Approval Notifications**: Create a workflow on Pipedream that sends real-time notifications to a Slack channel when a proposal is approved. This facilitates immediate action and ensures that all relevant team members are informed promptly, fostering a collaborative environment.
Loading