Skip to main content

Getting started

Create a new plugin​

To create an asset source plugin first clone this template project.

Change the name to something appropriate for your plugin and assign a unique ID (this can be anything, but it must be unique to your account):

registerVevPlugin({
  name: "Your plugin name",
  id: '[your-id]',
  ...
});

In your project directory run:

cd [my-project]
vev init

and after this is successful:

vev deploy

Connecting a plugin​

To connect and start using your plugin go to editor plugins in account settings. You should now see your new plugin in the list and be able to connect it:

image

After connecting the plugin you should now be able to see the results in the Vev design editor:

image

Logs and debugging​

To see the logs of your asset source after you have connected it go to editor plugins in account settings. In the dropdown to the right there is an option to open the log viewer: image

Further reading​

  • To learn more about the handler function and supported return types, visit this page.
  • For information on handling secrets, such as API keys and other credentials, go here.
  • To understand how to add configurable settings to your plugin, refer to [this guide].
  • For details on adding filtering or advanced search features in the Vev editor, check out [this resource].