Jump to a Section

Overview

The first time you add a Showpad card to a FLO, you will need to create a configuration. This will allow you to connect to your account, save your account information, and reuse that configuration next time you build a FLO with the connector. That way, you don’t have to sign in every time you want to build a FLO with this Connector. Instead, use the configuration you have already set up. You can create and save multiple configurations and share them with your teammates.

Here’s how to set up a new configuration in Showpad:

  1. First, enter the name of to this specific showpad connection. This should be unique so if you are connecting multiple Showpad accounts you will be able to tell them apart.
  2. Then enter in the domain that has been provided for you. This will be the full URL of your instance without http, For example yourcompany.showpad.biz is a legal domain. Note: there should NOT be a word staging in the domain url, however if it does contain staging, for exampleyourcompany.staging.showpad.biz please use Showpad Staging card instead.
  3. Finally, click “Create” to finish this configuration. The card will create connection that can be be used on subsequent showpad cards.

    Events

    • File Re-Shared

      Should trigger a FLO when a file in re-shared by a client.

    • File Shared

      Should trigger a FLO when a file in shared with a client.

    • File Viewed

      Should trigger a FLO when a file in viewed by a client it is shared with.

    Actions

    • Custom API Action

      This action allows you to make a custom, authenticated API request to the Showpad API.

      Options:

      • Request Type (dropdown): your available HTTP request methods. There are 5 supported HTTP request methods (sometimes called verbs) in custom API calls:

        • GET: retrieves data from a web server based on your parameters. GET requests a representation of the specified resource, and if successful will receive a 200 OK response message with the requested content. Additional documentation here.

        • POST: sends data to a web server based on your parameters. POST requests include actions like uploading a file. Multiple POST’s may result in a different outcome than a single POST, so you should be cautious about unintentionally sending multiple POST’s. If a POST is successful, you will receive a 200 OK response message. Additional documentation here.

        • PUT: sends data to a location in the web server based on your parameters. PUT requests include actions like uploading a file. The difference between a PUT and POST is that PUT is idempotent, meaning that the result of a single successful PUT is the same as many identical PUT’s. If a PUT is successful, you will receive a 200 response message (usually 201 or 204). Additional documentation here.

        • PATCH: applies partial modifications to a resource on a web server based on your parameters. PATCH is not idempotent, meaning that the result of multiple PATCH’s could have unintended consequences. If a PUT is successful, you will receive a 200 response message (usually 204). Additional documentation here.

        • DELETE: deletes the specified resource from the web server based on your parameters (if the resource exists). If a DELETE is successful, you will receive a 200 OK response message. Additional documentation here.

      Input Fields:

      • Relative URL (string): This is everything that comes after https://yoursubdomain.showpad.biz/api. Note that you need to specify the API version number in this field.

        Example: /v3/assets.json
      • Query (object): Any query parameters can be passed as an object.

        Example: {"name":"test"}
      • Body (object): Any body parameters can be passed as an object.

        Example: {"name":"test"}
      • Headers (object): Any additional headers that you need for your request. You do not need to enter “Authorization” headers, as these will be added to the call when it runs.

        Example: {"Content-type":"text/html"}

      Output Fields:

      • Status Code (Number): the success or failure of your HTTP request. Here is a list of all status codes.

      • Headers (object): a more detailed context for the response/status code that doesn’t relate to the output body. Not all headers that appear in a response header are response headers, meaning that some are unlikely to be useful to you. The response headers are dependent on the HTTP request you choose in options.

      • Body (object): depending on the HTTP request you chose in Options, you may receive some data back. That data, such as the data from a GET request, will be contained in this Body object.

    • Delete File

      This action allows you to delete a file from Showpad using the Showpad API.

      Options:

      • Choose Library (dropdown): your available libraries from which you can delete a file.

        • –Use Library ID–: use when you know the ID of the library from which you would like to delete.

        • Your Library Names: choose a specific library from your collection to delete from.

      Input Fields:

      • Library ID(text): The unique ID of the library you are deleting from.

      • External ID(text): The unique ID of the file you would like to delete. Note, you can find this ID if you used a FLO to upload your file by looking at the file’s External ID in your upload FLO’s history.

    • Read File Info

      Read metadata about a file in a certain library based on an external ID

    • Read Libraries

      Read a list of all libraries

    • Update File Info

      Update metadata on an existing file.

    • Upload File

      This action allows you to upload a file to Showpad using the Showpad API.

      Options:

      • Choose Library (dropdown): your available libraries to which you can add a file.

        • –Use Library ID–: use when you know the ID of the library to which you would like to add a file.

        • Your Library Names: choose a specific library from your collection when you know the name of the library to delete from.

      Input Fields:

      • Upload Library ID(text): The unique ID of the library you are uploading to.

      • Upload File Content(file): the file contents that you want to upload.

      • Upload External ID(text): The unique ID of the file. We suggest using a Unique ID text function card and using the output from that card for this field.

      • Upload File Name(text): The file name of the file.

      • Upload Description(text): The description of the file.

      • Upload Tags(list): The tags of the file you would like to upload.

      • Upload Hide Lable(T/F): A True/False value determining whether the file will show a label.

      • Upload Is Annotable(T/F): A True/False value determining whether the file will be annotatable.

      • Upload Is Downloadable(T/F): A True/False value determining whether the file will be downloadable.

      • Upload Is Sensitive(T/F): A True/False value stating whether the file is sensitive.

      • Upload Is Shareable(T/F): A True/False value determining whether the file will be sharable.

      • Upload Is Editable(T/F): A True/False value determining whether the file will be editable.

      Output Fields:

      • File File ID(Text): A unique ID identifying the file.

      • File Name(Text): The name the appears on the image in Showpad.

      • File Type(Text): What kind of file you are uploading.

      • File Extension(Text): The extension of the file.

      • File Library ID(Text): The unique ID of the library the file will be uploaded to.

      • File External ID(Text): A unique ID identifying the file

      • File Description(Text): The description of the file.

      • File Expires At(Date & Time): The date the file expires.

      • File Hide Lable(T/F): A True/False value determining whether the file will show a label.

      • File Is Annotatable(T/F): A True/False value determining whether the file will be annotatable.

      • File Is Downloadable(T/F): A True/False value determining whether the file will be downloadable. .

      • File Is Sensitive(T/F): A True/False value determining whether the file is sensitive.

      • File Shareable(T/F): A True/False value determining whether the file will be shareable.

      • File Is Editable(T/F): A True/False value determining whether the file will be editable.

      • File Released At(Date & Time): The date the file was released.

      • File Source(Text): The source of the file.

      • File Tags(List): A list of tags associated with the file.

      • File Upload URL(Text): The URL the file will be uploaded to.

      • File Created At(Date & Time): The time the file was created.

      • File Updated At(Date & Time): The time the file was updated.