Skip to content

AI Agents & MCPs & AI Workflow Automation • (~400 MCP servers for AI agents) • AI Automation / AI Agent with MCPs • AI Workflows & AI Agents • MCPs for AI Agents

8.6 KB
Raw Blame
import { createAction } from '@activepieces/pieces-framework';
import { HttpMethod, HttpRequest } from '@activepieces/pieces-common';
import { convertkitAuth } from '../auth';
import { kitHttp } from '../common/http';
import {
  broadcastId,
  broadcastPageNumber,
  broadcastContent,
  description,
  broadcastEmailAddress,
  emailLayoutTemplate,
  isPublic,
  publishedAt,
  sendAt,
  subject,
  thumbnailAlt,
  thumbnailUrl,
} from '../common/broadcasts';
import { Broadcast } from '../common/types';
import { BROADCASTS_API_ENDPOINT } from '../common/constants';
import { buildQueryParams, fetchBroadcasts } from '../common/service';
import {
  kitBroadcastListOutputSchema,
  kitBroadcastOutputSchema,
  kitBroadcastStatsOutputSchema,
  kitRequestStatusOutputSchema,
} from '../output-schemas';

export const listBroadcasts = createAction({
  auth: convertkitAuth,
  name: 'broadcasts_list_broadcasts',
  classification: 'SEARCH',
  outputSchema: kitBroadcastListOutputSchema,
  displayName: 'List Broadcasts',
  description: 'List all broadcasts',
  audience: 'human',
  aiMetadata: {
    description:
      'Retrieves a page of broadcasts (one-off emails) in the ConvertKit account, 50 per page. Use it to find a broadcast ID before getting, updating, or deleting one. Read-only and idempotent; pass a page number to fetch beyond the first 50.',
    idempotent: true,
  },
  props: {
    page: broadcastPageNumber,
  },
  run(context) {
    const page = context.propsValue.page || 1;
    return fetchBroadcasts(context.auth.secret_text, page);
  },
});

export const createBroadcast = createAction({
  auth: convertkitAuth,
  name: 'broadcasts_create_broadcast',
  classification: 'WRITE',
  outputSchema: kitBroadcastOutputSchema,
  displayName: 'Create Broadcast',
  description: 'Create a new broadcast',
  audience: 'human',
  aiMetadata: {
    description:
      'Creates a new email broadcast (one-off email), optionally scheduled via the send-at field; without it the broadcast is saved unsent. Not idempotent — every call creates another broadcast, so do not retry blindly.',
    idempotent: false,
  },
  props: {
    content: broadcastContent,
    description,
    emailAddress: broadcastEmailAddress,
    emailLayoutTemplate,
    isPublic,
    publishedAt,
    sendAt,
    subject,
    thumbnailAlt,
    thumbnailUrl,
  },
  async run(context) {
    const {
      content,
      description,
      emailAddress,
      emailLayoutTemplate,
      isPublic,
      publishedAt,
      sendAt,
      subject,
      thumbnailAlt,
      thumbnailUrl,
    } = context.propsValue;
    const url = BROADCASTS_API_ENDPOINT;

    const body = {
      api_secret: context.auth.secret_text,
      content,
      description,
      email_address: emailAddress,
      email_layout_template: emailLayoutTemplate,
      public: isPublic,
      published_at: publishedAt,
      send_at: sendAt,
      subject,
      thumbnail_alt: thumbnailAlt,
      thumbnail_url: thumbnailUrl,
    };

    const request: HttpRequest = {
      url,
      method: HttpMethod.POST,
      body,
      headers: {
        'Content-Type': 'application/json',
      },
    };
    const response = await kitHttp.sendRequest<{ broadcast: Broadcast }>(
      request
    );
    if (response.status !== 201) {
      throw new Error(`Error creating broadcast: ${response.status}`);
    }
    return response.body.broadcast;
  },
});

export const getBroadcastById = createAction({
  auth: convertkitAuth,
  name: 'broadcasts_get_broadcast',
  classification: 'READ',
  outputSchema: kitBroadcastOutputSchema,
  displayName: 'Get Broadcast',
  description: 'Get a broadcast',
  audience: 'human',
  aiMetadata: {
    description:
      'Fetches a single broadcast by its ID, returning its content and settings. Use when the broadcast ID is already known (e.g. from List Broadcasts); for delivery metrics use Broadcast Stats instead. Read-only and idempotent.',
    idempotent: true,
  },
  props: {
    broadcastId: broadcastId,
  },
  async run(context) {
    const { broadcastId } = context.propsValue;
    const url = `${BROADCASTS_API_ENDPOINT}/${broadcastId}`;

    const request: HttpRequest = {
      url,
      queryParams: buildQueryParams(context.auth.secret_text),
      method: HttpMethod.GET,
    };
    const response = await kitHttp.sendRequest<{ broadcast: Broadcast }>(
      request
    );
    if (response.status !== 200) {
      throw new Error(`Error fetching broadcast: ${response.status}`);
    }
    return response.body.broadcast;
  },
});

export const updateBroadcast = createAction({
  auth: convertkitAuth,
  name: 'broadcasts_update_broadcast',
  classification: 'WRITE',
  outputSchema: kitBroadcastOutputSchema,
  displayName: 'Update Broadcast',
  description: 'Update a broadcast',
  audience: 'human',
  aiMetadata: {
    description:
      'Updates the content, subject, scheduling, or other fields of an existing broadcast by broadcast ID. Idempotent — repeating the same update leaves the broadcast in the same state. Requires a valid broadcast ID from List Broadcasts.',
    idempotent: true,
  },
  props: {
    broadcastId: broadcastId,
    content: broadcastContent,
    description,
    emailAddress: broadcastEmailAddress,
    emailLayoutTemplate,
    isPublic,
    publishedAt,
    sendAt,
    subject,
    thumbnailAlt,
    thumbnailUrl,
  },

  async run(context) {
    const {
      broadcastId,
      content,
      description,
      emailAddress,
      emailLayoutTemplate,
      isPublic,
      publishedAt,
      sendAt,
      subject,
      thumbnailAlt,
      thumbnailUrl,
    } = context.propsValue;

    const url = `${BROADCASTS_API_ENDPOINT}/${broadcastId}`;

    const body = {
      api_secret: context.auth.secret_text,
      content,
      description,
      email_address: emailAddress,
      email_layout_template: emailLayoutTemplate,
      public: isPublic,
      published_at: publishedAt,
      send_at: sendAt,
      subject,
      thumbnail_alt: thumbnailAlt,
      thumbnail_url: thumbnailUrl,
    };

    const request: HttpRequest = {
      url,
      method: HttpMethod.PUT,
      body,
      headers: {
        'Content-Type': 'application/json',
      },
    };
    const response = await kitHttp.sendRequest<{ broadcast: Broadcast }>(
      request
    );
    if (response.status !== 200) {
      throw new Error(`Error updating broadcast: ${response.status}`);
    }
    return response.body.broadcast;
  },
});

export const broadcastStats = createAction({
  auth: convertkitAuth,
  name: 'broadcasts_broadcast_stats',
  classification: 'READ',
  outputSchema: kitBroadcastStatsOutputSchema,
  displayName: 'Broadcast Stats',
  description: 'Get broadcast stats',
  audience: 'human',
  aiMetadata: {
    description:
      'Retrieves delivery and engagement statistics (recipients, opens, clicks, unsubscribes) for one broadcast by ID. Pick this over Get Broadcast when performance metrics are needed rather than content. Read-only and idempotent.',
    idempotent: true,
  },
  props: {
    broadcastId: broadcastId,
  },
  async run(context) {
    const { broadcastId } = context.propsValue;
    const url = `${BROADCASTS_API_ENDPOINT}/${broadcastId}/stats`;

    const request: HttpRequest = {
      url,
      queryParams: buildQueryParams(context.auth.secret_text),
      method: HttpMethod.GET,
    };
    const response = await kitHttp.sendRequest<{ broadcast: Broadcast }>(
      request
    );
    if (response.status !== 200) {
      throw new Error(`Error fetching broadcast stats: ${response.status}`);
    }
    return response.body.broadcast;
  },
});

export const deleteBroadcast = createAction({
  auth: convertkitAuth,
  name: 'broadcasts_delete_broadcast',
  classification: 'DESTRUCTIVE',
  outputSchema: kitRequestStatusOutputSchema,
  displayName: 'Delete Broadcast',
  description: 'Delete a broadcast',
  audience: 'human',
  aiMetadata: {
    description:
      'Permanently deletes a broadcast by ID. Destructive and not retry-safe — a repeat call fails once the broadcast is gone, so confirm the ID via List Broadcasts first.',
    idempotent: false,
  },
  props: {
    broadcastId: broadcastId,
  },
  async run(context) {
    const { broadcastId } = context.propsValue;
    const url = `${BROADCASTS_API_ENDPOINT}/${broadcastId}`;

    const body = {
      api_secret: context.auth.secret_text,
    };

    const request: HttpRequest = {
      url,
      body,
      method: HttpMethod.DELETE,
    };
    const response = await kitHttp.sendRequest<{ broadcast: Broadcast }>(
      request
    );
    if (response.status !== 204) {
      throw new Error(`Error deleting broadcast: ${response.status}`);
    }
    return {
      message: `Broadcast ${broadcastId} deleted successfully`,
      status: response.status,
      success: true,
    };
  },
});