Synthesia Private Beta API

Welcome to the Synthesia developer hub. You'll find comprehensive guides and documentation to help you start working with Synthesia as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Zapier App

Set up the world's first automatic video personalization flows with Synthesia and Zapier. No coding required.

πŸ‘‰ Find Synthesia App on Zapier
πŸ‘‰ Create example personalized video

The goal of this guide is to help you set up automated flows which will create and send completely personalized videos to your customers/employees/partners without code. All this can be achieved with Synthesia Zapier app - without any code and in less than an hour.

Table of contents:

What are the use cases for Zapier with Synthesia?

  • πŸ‘‹ Greeting high value leads
    Applicable zaps: Hubspot, Mailchimp, Webflow, etc.
  • πŸ“… Asking high value leads for a meeting
    Applicable zaps: Hubspot, Mailchimp, Webflow, etc.
  • πŸ™ Greeting/thanking new customers
    Applicable zaps: Shopify, Hubspot, etc.
  • πŸ›’ Pinging abandoned cart customers
    Applicable Zaps: Shopify, etc.
  • πŸ€” Thanking survey responders
    Applicable Zaps: Typeform, Google Forms etc.
  • πŸ‘ Thanking job applicants
    Applicable Zaps: Workable, Greenhouse, etc.
  • You can see some more potential examples here.

What do you need to start using Synthesia with Zapier?

1. πŸ—οΈ Get Synthesia API key

You need to become a paid Synthesia STUDIO user in order to get access to your API keys. You can create your account here. Once you’ve become a Synthesia STUDIO user, head to accounts settings, scroll down to "API Keys" area, and create a new API key (you'll use this later in Zapier to connect with Synthesia).

2. πŸ€– Use Synthesia Zapier app

Synthesia Zapier app can be found in Zapier or here.

3. πŸ’Έ Choose a Synthesia API pricing package

Once you've tested your use case and want to start using the API for real, you need to purchase one of our API packages. Please head here to see and purchase Synthesia API packages.


How to set up Zapier + Synthesia?

Below you can see a visualized view of a possible Zapier integration with Synthesia. It includes a creation of two zaps. The first zap will serve as a trigger for video creation based on a customer lifecycle event.

Remember it takes from 3-10 minutes for the video to be created at the moment. The second zap will then be triggered when the video is ready to be sent to your user via email or SMS.


πŸŽ₯ Set up Zap 1: Generate personalized video

This first zap will serve as a trigger for video creation based on a customer lifecycle event. Remember it takes from 3-10 minutes for the video to be created at the moment. The second zap below will then be triggered when the video is ready to be sent to your user.

Here comes a bit of your creativity into play. Think about your use case and your user touchpoint that you want to use as a trigger to send a personalized video message.

⚑ Zap Trigger: Pick your existing tool

Below are a few Zapier triggers that you could use as the step 1:

  • Hubspot (New Form Submission, New Contact Property Change…)
  • Typeform (New Entry)
  • Shopify (New Customer, New Abandoned Cart…)
  • Webflow (Form Submission)
  • Mailchimp (New Customer, New Order…)
  • Calendly (Invitee Created)
  • And many more

πŸŽ₯ Zap Action: Synthesia Request New Video

In the Zapier action, provide the template ID and template data of the template that you'd like to base your final video on.

If you're not familiar with templates, make sure to have a look at this guide before continuing.

Optionally, you may provide a title and description for the final video. If you don't provide one, it will use the values from the template (which may be variables themselves).

Finally, if required, specify the callback ID. This field is video-specific and is included in any video events or payloads. This means that it may be used to store metadata that is meaningful to you. For example, you might choose to store the customer's email from step one so that in a later step, you can use this email address.

πŸ“˜

How to maximize personalization in the video script?

Think creatively about the final video. The more personalization points from step one above that you include, the more personalized the final video will feel.

You can include anything that might be relevant to your message recipient: name, industry, title, position, company, product, etc.

Feeling extra creative? You can even use Zapier Paths after step one to conditionally generate different templates or populate variables with different values. This way, you can tailor the final video based on your user's inputs and choices.


πŸ“¨ Set up Zap 2: Send video to user

This second zap will serve as a way to send an email/SMS to your user with the personalized video. In the simplest form it can have 2 steps. Let's look at them below.

⚑ Zap Trigger: Synthesia New Video Ready

Simply select Synthesia New Video Ready Trigger. No other input is required here.

πŸ“¨ Zap Action: Pick an email/SMS provider

Below are a few possible actions to use here to send the email/SMS to your customer (depending on your tool of choice):

  • Email by Zapier
  • Gmail
  • Mandrill
  • Twilio
  • Amazon SES
  • Postmark
  • or any other email/SMS tool you use and is supported by Zapier

Now, the only thing left is to define the standard parameters for the email. Below is one of our examples.

To: <Callback ID from Step 1>
Subject: New to Synthesia?
Body:

<p>Hey there,</p>

<p>I'm super happy to see you in Synthesia.</p>

<p>To make a first successful video you can follow our <a href="https://help.synthesia.io/tips">tips here</a>.</p>

<p>And btw. here is a video created uniquely for you:</p>
<a href="<share_page_URL_from_step_1>">
  <img src="<thumbnail_URL_from_step_1>" width="500">
</a>

<p>πŸŽ₯ <a href="<share_page_URL_from_step_1>">Link to video</a></p>

πŸ“˜

Need more personalization variables in email?

Want to use more personalization variables in the email body or use different email templates depending on the recipient?

You can do this by simply passing more parameters via Callback ID in the Zap 1 and then use another step in Zap 2 before sending the email to separate Callback ID into several paramaters (Formatter by Zapier -> Text -> Transform -> Split Text -> Separator that you used in Zap 1 eg. "," -> Segment Index: All as separate fields). This for example enable us to pass a more complex Callback ID that helps us respond to different events with different emails.

Updated 11 days ago


Zapier App


Set up the world's first automatic video personalization flows with Synthesia and Zapier. No coding required.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.