Gmail Integration

Uploads from the Gmail API support the following types of files:

All file types are selectable. This includes audio, video, image, text, office, and compressed archive files.

Section Quick Jump:

API OAUTH Webhooks


Using the Gmail API

  1. User selects Gmail from services list
  2. user authenticates connection by logging into Gmail account
  3. user is connected and can select files from Gmail in Filestack dialog

Gmail api upload widget

Upload from Gmail

Uploading or "picking" a file from Gmail in the context of Filestack means choosing a file and creating a distributable link to that file where it exists in Gmail. This is the Filestack URL that all "Pick" functions return. If you are using the pickAndStore method, then the file from Gmail is copied to a new storage location.

Sample Upload Code
filepicker.pick( { mimetypes: ['*/*'], services:['GMAIL'], }, function(Blob){ console.log(JSON.stringify(Blob)); } );

Download to Gmail

Exporting a file to Gmail with Filestack is not currently possible.

Sample Image Conversion Code for Gmail

If you have a Filestack Blob object or Filestack URL, then you can use the Filestack REST or Javascript APIs to convert office documents and image files. In the sample code below we "pick" an image file from Gmail and use the Javascript API convert method to resize the image to 400w by 400h in pixels.

Sample Conversion Code
filepicker.pick( { services: ['GMAIL'], mimetype: 'image/*', }, function(pickedBlob){ console.log("Conversion in progress...") filepicker.convert( pickedBlob, { width: 400, height: 400, }, { location: 'S3' }, function(convertedBlob){ console.log("Converted file url: ", convertedBlob.url); console.log("File is stored under your S3: ", convertedBlob.key); filepicker.remove( pickedBlob, function(){ console.log("Removed"); } ); } ); } );

Create your own Gmail OAuth application to Connect to Filestack:

By default, you do not need to configure anything to start uploading photos from Gmail, Filestack is ready to go out of the box. When a user logs into their Gmail account from your site, the Filestack company application will show up. You can configure it so that your application shows up instead in order to make a more seamless experience for your customers. So let's get started.

  1. Go to https://console.developers.google.com/project and sign into your google account. Now click create project, give the project a name and click create.
  2. create a new project in your google account
  3. Use the side menu to select Credentials,then click Add Credentials, and select OAuth Client ID.
    click Credentials in the side menu and create a new oauth client id
  4. On the next page click Configure consent screen. Product name is the only required field for the consent screen. Enter the information you want to display and click save.
    click Configure consent screen
    enter the information you want displayed on the consent screen
  5. Now you can select your application type. Select Web Application and enter https://www.filestackapi.com/api/client/gmail/authCallback/open in the Authorized redirect URIs field, and click create. You will be presented with your client ID and client secret. Copy these.
    select Web Application as the application type
    Copy your client ID and client secret
  6. Now go to the Filestack developer portal and click on Auth Keys, scroll down to the bottom and enter the client ID and the client secret into the Gmail fields for App Key and App Secret and click Save Auth Credentials.
    enter the App Key and App Secret for your app in the Filestack developer portal
  7. Go and test that you can connect to your Gmail application through Filestack.
    Test that your application works, you should see the consent screen you configured
    Congratulations, your Gmail application works

Congratulations! Your custom Gmail application is all set up for use with Filestack!

Gmail Webhooks for Your Application

Gmail Webhooks serve the purpose of notifying users about events that occur in relation to their Filestack account. In your developer portal, you can set one or many urls whose purpose is to receive the messages triggered by specific Filestack events.

These are the three event types that will send messages to your webhook url(s) concerning Gmail:

  • Gmail File Uploads
  • Gmail File Exports
  • Gmail File Conversions

Configuring Gmail Webhooks

Filestack Webhooks are configured in the developer portal under Credentials > Webhooks. If you enter your url and select "All", then one entry will be made for each type of Filestack Webhook Event, including the ones for Gmail. To learn more about configuring and receiving webhooks please visit our main webhooks documentation page.

Receiving a Gmail Webhook Notification

Configuring your server to receive a new webhook is the same as creating any page on your website. If you are using Sinatra, add a new route with the desired URL. In PHP you could create a new .php file on your server. It doesn't need to be complicated. With webhooks, your server is the server receiving the request. You can even use an external service such as RequestBin as shown in the screenshot above.

Webhook data is sent as JSON in the request's body. The full event details are included and can be used directly. The "action" in the JSON is the type of Filestack event that happened, be it a file being uploaded, or simply the Filestack dialog opening.

Filestack will retry sending a webhook 3 times if the first attempt fails. The second attempt to deliver a webhook happens 5 minutes after the first attempt, the third attempt happens after 1 hour, and the final attempt to deliver a webhook happens 12 hours after the first attempt.

Note that for file uploads, both symlinks and files copied with pickAndStore, the "client" field shows the service used.

For conversions, the "provider" shows where the file resides. If the file was stored to Filestack's storage, the provider will be "internal", otherwise it could be "amazon" if the original was stored to S3, or one of the cloud drives Filestack connects to, such as "Gmail" if the link to the file was a symlink.

The following are examples of what the Gmail specific webhook messages include and look like:

  1. File Upload (symlink):

  2. {  
       "action":"fp.upload",
       "timestamp":1443444905,
       "id":100946,
       "text":{  
          "url":"https://www.filestackapi.com/api/file/WAunDTTqQfCNWwUUyf6n",
          "client":"Gmail",
          "type":"image/jpeg",
          "filename":"1579337399020824.jpg",
          "size":139154
       }
    }

  3. File Upload (with store):

  4. {
       "action":"fp.upload",
       "timestamp":1443515345,
       "id":105258,
       "text":{
          "container":"kg_bucket",
          "url":"https://www.filestackapi.com/api/file/0CpUz9H4QfaX7LwwsgUf",
          "filename":"Cat_crying_Lolcat.jpg",
          "client":"Gmail",
          "key":"EqACdfNRmylz2h1SSYwT_Cat_crying_Lolcat.jpg",
          "type":"image/jpeg",
          "size":205354
       }
    }

  5. File Export (save to):

  6. {
      "action": "fp.export",
      "timestamp": 1444257665, 
      "id": 142447, 
      "text":{
        "source": "https://www.filestackapi.com/api/file/qHi4LxRh28IeEBdJcFpw",
        "client": "Gmail",
        "filename": "newFiletest.jpg",
        "created": "https://www.filestackapi.com/api/file/s40jJOQDGVr2T86cgOAe"
      }
    }
            

  7. File Conversion:

  8. {
       "action":"fp.converse",
       "timestamp":1435586806,
       "text":{
          "url":"https://www.filestackapi.com/api/file/uydUKAcTSsWB3g5HOsB4/convert?w=102",
          "link":{
             "writeable":true,
             "mimetype":"image/jpeg",
             "handle":"uydUKAcTSsWB3g5HOsB4",
             "url":"filepicker_upload_persist/pHSrbCRqSqeR1wh8USfY_1.jpeg",
             "created_at":"2015-06-29T13:31:02.204Z",
             "provider":"Gmail",
             "app_id":7876,
             "filename":"1.jpeg",
             "mongo_id":null,
             "_metadata":null,
             "access_tokens":[
    
             ],
             "is_folder":false,
             "persist":false,
             "user_id":null,
             "id":31968,
             "size":"111175"
          }
       },
       "id":109
    }