View as Markdown
HeyGen icon

HeyGen TRIGGER

New Avatar Video Custom Event (Instant)

Emit new event when a specific avatar video event occurs. The user can define a custom set of event(s) to trigger. See the documentation
  • Trigger
  • Instant
  • API key
  • Webhook delivery

IMPLEMENTATION

Deploy this event source

Connect the user's HeyGen account, configure the source, and choose the webhook where your backend receives events.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const deployed = await pd.triggers.deploy({
  id: "heygen-new-avatar-video-custom-event",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    heygen: { authProvisionId: "apn_xxxxxxx" },
    customEvents: ["Custom Events"],
  },
  webhookUrl: "https://example.com/webhooks/heygen",
})

console.log(deployed.id)

MCP exposes on-demand actions. Event sources are deployed through the Connect SDK or API because they continue listening after the initial request.

SCHEMA

Configuration

These inputs define which events the source watches. Dynamic options are loaded from the connected account.

New Avatar Video Custom Event (Instant) configuration
Property Type Description
customEvents Custom Events string[]
A custom set of event(s) that the user wants to trigger
Required Dynamic

01

Connect

Your user authorizes HeyGen through Pipedream managed auth.

02

Deploy

Your backend deploys this source with that user's own configuration.

03

Webhook delivery

Every event is sent to the HTTP endpoint you choose when you deploy the source — as it happens.

OR

On-demand retrieval

No webhook required. Your app or agent can fetch recent events from the trigger events API.

Registry key
heygen-new-avatar-video-custom-event
Version
0.0.1
App
HeyGen
Authentication
API key
Delivery
Instant event
Output
Events emitted by HeyGen.