Shotgun
      Back to home
      1. Knowledge Base
      2. Integrations
      3. Shotgun

      Setting up your SyncSketch to Shotgun Integration

      Shotgun is one of the most popular production management tools for VFX,  Gaming and Animation. Users have been requesting an integration between SyncSketch and Shotgun for a long time. Instead of copying and  pasting review data into both systems we released the first version of the integration. 

      To see how the Shotgun integration might help you, have a look at the article on syncing playlists and notes here

      Integrating the two systems is straightforward. All you need to do is create a Script User in Shotgun with access to Playlists, Shots, Versions and Notes, so SyncSketch can synchronize reviews and push notes back into Shotgun. Let's get started.

      Creating a Shotgun Script User

      Shotgun gives you the option to create script based users which allow developers to communicate with Shotgun through a programming interface (API).  You can find the option to create a script user in Shotguns main user menu  about half way down.

      Once you have selected "Scripts" you'll see the script users overview page. Please hit the "+ Script" button to open the dialog. The name of the script user can be anything e.g. "syncsketch_api"



      Please get in touch for the least set of permissions for the script to operate.

       

      Note - you can find a list of necessary minimal permissions here

       

      To summarize, for our integration to work you need:

      1.  The script name (without spaces)
      2. The URL of your website e.g https://yourstudio.shotgunstudio.com
      3. The Application Key

      Activating the Integration

      Currently the Shotgun Integration is only available on our Enterprise Plan. If you want to test the integration, please:

      1. Create your account
      2. Upgrade to Pro Plan with a 14 day trial
      3. Send an email to "support@syncsketch.com"

      We will then go ahead and activate the Shotgun Integration for you which will expose the following UI in your workspace settings:



       

      Project Level Settings

      You can also set up your Shotgun integration at the Project level - this would allow you to control which projects have access to Shotgun through the integration.  You could also set up different projects with different Shotgun entities.

       

      If you're using a Shotgun Firewall, please refer to our Whitelisting our domains for your Firewall article.  Please note: this is only necessary if you already have a Shotgun Firewall enabled.