Submit Image to Alttextify with AltTextify API on New Message In Channels (Instant) from Slack API

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

Trigger workflow on

New Message In Channels (Instant) from the Slack API

Next, do this

Submit Image to Alttextify with the AltTextify 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 Slack trigger and AltTextify action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Message In Channels (Instant) trigger
1. Connect your Slack account
2. Optional- Select one or more Channels
3. Configure slackApphook
4. Optional- Configure Resolve Names
5. Optional- Configure Ignore Bots
6. Optional- Configure Ignore replies in threads
Configure the Submit Image to Alttextify action
1. Connect your AltTextify account
2. Configure alert
3. Configure Async
4. Configure Image
5. Configure Language
6. Configure Max Characters
7. Optional- Configure Asset ID
8. Optional- Configure Keywords
9. Configure Ecommerce Run OCR
10. Optional- Configure Ecommerce Product Name
11. Optional- Configure Ecommerce Product Brand
12. Optional- Configure Ecommerce Product Color
13. Optional- Configure Ecommerce Product Size
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 Message In Channels (Instant) on Slack

Description:Emit new event when a new message is posted to one or more channels

Version:1.0.25

Key:slack-new-message-in-channels

View on GitHub

Slack Overview#

The Pipedream Slack app enables you to build event-driven workflows that interact with the Slack API. Once you authorize the Pipedream app's access to your workspace, you can use Pipedream workflows to perform common Slack actions or write your own code against the Slack API.

The Pipedream Slack app is not a typical app. You don't interact with it directly as a bot, and it doesn't add custom functionality to your workspace out of the box. It makes it easier to automate anything you'd typically use the Slack API for, using Pipedream workflows.

Automate posting updates to your team channels
Create a bot to answer common questions
Integrate with your existing tools and services
And much more!

Trigger Code#

import common from "../common/base.mjs";
import constants from "../common/constants.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "slack-new-message-in-channels",
  name: "New Message In Channels (Instant)",
  version: "1.0.25",
  description: "Emit new event when a new message is posted to one or more channels",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    conversations: {
      propDefinition: [
        common.props.slack,
        "conversation",
      ],
      type: "string[]",
      label: "Channels",
      description: "Select one or more channels to monitor for new messages.",
      optional: true,
    },
    // eslint-disable-next-line pipedream/props-description,pipedream/props-label
    slackApphook: {
      type: "$.interface.apphook",
      appProp: "slack",
      async eventNames() {
        return this.conversations || [
          "message",
        ];
      },
    },
    resolveNames: {
      propDefinition: [
        common.props.slack,
        "resolveNames",
      ],
    },
    ignoreBot: {
      propDefinition: [
        common.props.slack,
        "ignoreBot",
      ],
    },
    ignoreThreads: {
      type: "boolean",
      label: "Ignore replies in threads",
      description: "Ignore replies to messages in threads",
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getSummary() {
      return "New message in channel";
    },
    async processEvent(event) {
      if (event.type !== "message") {
        console.log(`Ignoring event with unexpected type "${event.type}"`);
        return;
      }
      if (event.subtype && !constants.ALLOWED_MESSAGE_IN_CHANNEL_SUBTYPES.includes(event.subtype)) {
        // This source is designed to just emit an event for each new message received.
        // Due to inconsistencies with the shape of message_changed and message_deleted
        // events, we are ignoring them for now. If you want to handle these types of
        // events, feel free to change this code!!
        console.log("Ignoring message with subtype.");
        return;
      }
      if ((this.ignoreBot) && (event.subtype == "bot_message" || event.bot_id)) {
        return;
      }
      // There is no thread message type only the thread_ts field
      // indicates if the message is part of a thread in the event.
      if (this.ignoreThreads && event.thread_ts) {
        console.log("Ignoring reply in thread");
        return;
      }
      if (this.resolveNames) {
        if (event.user) {
          event.user_id = event.user;
          event.user = await this.getUserName(event.user);
        } else if (event.bot_id) {
          event.bot = await this.getBotName(event.bot_id);
        }
        event.channel_id = event.channel;
        event.channel = await this.getConversationName(event.channel);
        if (event.team) {
          event.team_id = event.team;
          event.team = await this.getTeamName(event.team);
        }
      }
      return event;
    },
  },
  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
Slack	`slack`	`app`	This component uses the Slack app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Channels	`conversations`	`string[]`	Select a value from the drop down menu.
	`slackApphook`	`$.interface.apphook`
Resolve Names	`resolveNames`	`boolean`	Instead of returning `channel`, `team`, and `user` as IDs, return their human-readable names.
Ignore Bots	`ignoreBot`	`boolean`	Ignore messages from bots
Ignore replies in threads	`ignoreThreads`	`boolean`	Ignore replies to messages in threads

Trigger Authentication#

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

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

channels:historychannels:readchannels:writeemoji:readgroups:historygroups:readgroups:writeim:historyim:readim:writelinks:readlinks:writempim:historympim:readmpim:writereactions:readreactions:writereminders:readreminders:writestars:readteam:readusergroups:readusergroups:writeusers:readusers:read.emailusers:writechat:write:botchat:write:userfiles:write:usercommandsusers.profile:writeusers.profile:readsearch:read

About Slack#

Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.

Action#

Submit Image to Alttextify on AltTextify

Description:Upload or submit an image to Alttextify for alt text generation. [See the documentation](https://apidoc.alttextify.net/#api-Image-UploadRawImage)

Version:0.0.1

Key:alttextify-submit-image

View on GitHub

Action Code#

import { getFileStreamAndMetadata } from "@pipedream/platform";
import alttextify from "../../alttextify.app.mjs";

export default {
  key: "alttextify-submit-image",
  name: "Submit Image to Alttextify",
  description: "Upload or submit an image to Alttextify for alt text generation. [See the documentation](https://apidoc.alttextify.net/#api-Image-UploadRawImage)",
  version: "0.0.1",
  type: "action",
  props: {
    alttextify,
    alert: {
      type: "alert",
      alertType: "info",
      content: "Supported formats: JPEG, PNG, GIF, WEBP, BMP\nMaximum file size: 16 MB\nMinimum dimensions: 50 x 50 (smaller images may not be able to generate alt text).",
    },
    async: {
      type: "boolean",
      label: "Async",
      description: "Whether to add the image in the background or immediately (synchronously). If async is set to true, the API response will always be successful with an empty response body.",
      default: false,
    },
    image: {
      type: "string",
      label: "Image",
      description: "The URL of the file or path to the file saved to the `/tmp` directory. [See the documentation on working with files](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp)",
    },
    lang: {
      type: "string",
      label: "Language",
      description: "The language for the alt text. Supported language codes are accepted. If not provided, the account's default language is used.",
      default: "en",
    },
    maxChars: {
      type: "integer",
      label: "Max Characters",
      description: "Maximum length of the generated alt text.",
    },
    assetId: {
      type: "string",
      label: "Asset ID",
      description: "The unique identifier for the asset.",
      optional: true,
    },
    keywords: {
      type: "string[]",
      label: "Keywords",
      description: "List of keywords/phrases for SEO-optimized alt text. Only one or two will be used per alt text, but all are considered. Keywords must be in English, even for alt text in other languages.",
      optional: true,
    },
    ecommerceRunOCR: {
      type: "boolean",
      label: "Ecommerce Run OCR",
      description: "Flag to indicate if OCR should be run on the product.",
    },
    ecommerceProductName: {
      type: "string",
      label: "Ecommerce Product Name",
      description: "The name of the product in the image.",
      optional: true,
    },
    ecommerceProductBrand: {
      type: "string",
      label: "Ecommerce Product Brand",
      description: "The brand of the product in the image.",
      optional: true,
    },
    ecommerceProductColor: {
      type: "string",
      label: "Ecommerce Product Color",
      description: "The color of the product in the image.",
      optional: true,
    },
    ecommerceProductSize: {
      type: "string",
      label: "Ecommerce Product Size",
      description: "The size of the product in the image.",
      optional: true,
    },
  },
  methods: {
    async streamToBase64(stream) {
      return new Promise((resolve, reject) => {
        const chunks = [];

        stream.on("data", (chunk) => {
          chunks.push(chunk);
        });

        stream.on("end", () => {
          const buffer = Buffer.concat(chunks);
          resolve(buffer.toString("base64"));
        });

        stream.on("error", (err) => {
          reject(err);
        });
      });
    },
  },
  async run({ $ }) {
    const {
      stream, metadata,
    } = await getFileStreamAndMetadata(this.image);
    const base64String = await this.streamToBase64(stream);

    const response = await this.alttextify.uploadImage({
      $,
      data: {
        async: this.async,
        image: `data:${metadata.contentType};base64,${base64String}`,
        lang: this.lang,
        maxChars: this.maxChars,
        assetId: this.assetId,
        keywords: this.keywords,
        ecommerce: {
          run_ocr: this.ecommerceRunOCR,
          product: {
            name: this.ecommerceProductName,
            brand: this.ecommerceProductBrand,
            color: this.ecommerceProductColor,
            size: this.ecommerceProductSize,
          },
        },
      },

    });

    $.export("$summary", `Successfully submitted image to Alttextify for alt text generation with Asset ID: ${response.asset_id}`);
    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
AltTextify	`alttextify`	`app`	This component uses the AltTextify app.
Async	`async`	`boolean`	Whether to add the image in the background or immediately (synchronously). If async is set to true, the API response will always be successful with an empty response body.
Image	`image`	`string`	The URL of the file or path to the file saved to the `/tmp` directory. See the documentation on working with files
Language	`lang`	`string`	The language for the alt text. Supported language codes are accepted. If not provided, the account's default language is used.
Max Characters	`maxChars`	`integer`	Maximum length of the generated alt text.
Asset ID	`assetId`	`string`	The unique identifier for the asset.
Keywords	`keywords`	`string[]`	List of keywords/phrases for SEO-optimized alt text. Only one or two will be used per alt text, but all are considered. Keywords must be in English, even for alt text in other languages.
Ecommerce Run OCR	`ecommerceRunOCR`	`boolean`	Flag to indicate if OCR should be run on the product.
Ecommerce Product Name	`ecommerceProductName`	`string`	The name of the product in the image.
Ecommerce Product Brand	`ecommerceProductBrand`	`string`	The brand of the product in the image.
Ecommerce Product Color	`ecommerceProductColor`	`string`	The color of the product in the image.
Ecommerce Product Size	`ecommerceProductSize`	`string`	The size of the product in the image.

Action Authentication#

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

About AltTextify#

AI Driven Alt Text Generation for Your Images

More Ways to Connect AltTextify + Slack#

Other Popular Integrations#

Retrieve Alt Text by Asset ID with AltTextify API on New Channel Created (Instant) from Slack API

Slack + AltTextify

Submit Image to Alttextify with AltTextify API on New Message In Channels (Instant) from Slack API

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

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

1
-
24
of
2,700+
apps by most popular