Let’s say you were developing an integration that allowed users to embed design files from your app natively within the Kit editor.

The full flow would look like this:

1

Create your content endpoint

Create a POST endpoint on your server to generate the JSON to render your media in the media gallery (see request URL for more details)

2

Create optional additional endpoints

Optionally

  • If using a dynamic filter (see dynamic select input for more details), create a POST endpoint on your server to return the elements for the filter select menu
  • If you require notification for image insertion (see request URLfor more details), create a POST endpoint on your server that we will call when an image has been placed into an email
3

Create & publish your app

You create your app within Kit and configure the designs plugin using the guide found here. Once your app and plugin are ready, you submit your app for approval and publish.

4

Creator installs your app

A Kit user installs your app, triggering your plugin’s OAuth authentication flow.

5

Creator navigates to your designs plugin

The Kit user navigates to an email and searches for your designs plugin by:

  • Using the / command to search for the name of your plugin or app, to filter the content menu
  • Pressing the + button and scrolling down to your plugin, found under your app’s heading
  • Using either method above to select image from the menu and navigating to the designs plugin found in the media gallery sidebar
6

Kit notifies you when the plugin is opened

Upon opening your plugin in the media gallery, our system makes an initial request to the endpoint in #1 for the default list of images we should show from your server. If your settings include a dynamic select, we will also make a request to the endpoint in step 2 to render the select elements in the filter dropdown

7

Kit notifies you on each creator interaction

Any time the creator interacts with and fills out all required settings, our system makes a request to your endpoint from #1 with the values

8

The images are rendered in the media gallery

You will return the JSON for the media source, which we’ll use to render the images in the media gallery for selection

9

Creator scrolls through the gallery

A creator scrolls through the list, triggering additional pagination requests from Kit

10

Creator selects an image

A creator selects an image, whereby Kit inserts the image into the email content - if you have set up image insertion notifications from step 2, we will also notify you at this point

Let’s say you were developing an integration that allowed users to embed design files from your app natively within the Kit editor.

The full flow would look like this:

1

Create your content endpoint

Create a POST endpoint on your server to generate the JSON to render your media in the media gallery (see request URL for more details)

2

Create optional additional endpoints

Optionally

  • If using a dynamic filter (see dynamic select input for more details), create a POST endpoint on your server to return the elements for the filter select menu
  • If you require notification for image insertion (see request URLfor more details), create a POST endpoint on your server that we will call when an image has been placed into an email
3

Create & publish your app

You create your app within Kit and configure the designs plugin using the guide found here. Once your app and plugin are ready, you submit your app for approval and publish.

4

Creator installs your app

A Kit user installs your app, triggering your plugin’s OAuth authentication flow.

5

Creator navigates to your designs plugin

The Kit user navigates to an email and searches for your designs plugin by:

  • Using the / command to search for the name of your plugin or app, to filter the content menu
  • Pressing the + button and scrolling down to your plugin, found under your app’s heading
  • Using either method above to select image from the menu and navigating to the designs plugin found in the media gallery sidebar
6

Kit notifies you when the plugin is opened

Upon opening your plugin in the media gallery, our system makes an initial request to the endpoint in #1 for the default list of images we should show from your server. If your settings include a dynamic select, we will also make a request to the endpoint in step 2 to render the select elements in the filter dropdown

7

Kit notifies you on each creator interaction

Any time the creator interacts with and fills out all required settings, our system makes a request to your endpoint from #1 with the values

8

The images are rendered in the media gallery

You will return the JSON for the media source, which we’ll use to render the images in the media gallery for selection

9

Creator scrolls through the gallery

A creator scrolls through the list, triggering additional pagination requests from Kit

10

Creator selects an image

A creator selects an image, whereby Kit inserts the image into the email content - if you have set up image insertion notifications from step 2, we will also notify you at this point