Creating Quip API workflows

To automate complex and repetitive tasks and complete actions in Quip, you can create workflows.

Learn more: Using the API block.

Adding global variables

Save time when you create integrations and run workflows by adding connection information as global variables.

1. Click Configuration > General > Global Settings.
2. Click Add new variable.
3. Add the key value, which is the name of the variable.
4. Enter the value.
5. Save your changes.

The name of the global variable is Quip.API URL. The value that you enter is your Quip API URL.

The default URL for Quip is https://platform.quip.com. However, if you're a VPC customer, use one of the following URI formats depending on the VPC URL assigned to your company:

• https://platform.<customername>.onquip.com
• https://platform.quip-<customername>.com

When you select a preset, you must enter the following information in the Configure section:

1. Your Quip credentials.
2. Your Quip API URL.  

To complete actions in QUIP, you can use the following presets:

• Create Folder
• Load User Details
• Add User to Folder
• Remove User from Folder

Quip Create Folder

The Quip Create Folder preset creates a new folder in Quip. To add the preset to a workflow, you must enter the Title of the folder. You can use the Advanced Mode to configure the message payload.

To do this, complete the following steps:

1. In the API block tab, click Advanced Mode.
2. In the Body tab, you can modify the title you added or enter additional values, such as the {{color}}or the {{member_ids}}of the folder. See Quip API documentation: Create a folder.
3. Select the RESPONSE tab. To map the entire response enter {{response}} in the Response field and map it to a custom long text Oomnitza field, such as API Response. When you have the response, you can map individual JSON values to the custom fields as shown in the screen capture.
4. 

Quip Load User Details

The Quip Load User Details loads the details of a Quip user.

Tip
You can get a user ID by running the Quip Create Folder preset. Alternatively, you can get a list of all Quip User IDs when you run the user integration. 

When you select the preset, you must provide a user ID. The Quip User ID is stored in the Advanced Mode.

1. Click Advanced Mode.
2. Select the INFORMATION tab. The Quip user ID is assumed to be stored in the field {{quip_user_id}}. If this is not the case, you can replace the field name in the URL field or enter the user ID directly.
3. Select the RESPONSE tab. To map the entire response enter {{response}} in the Response field and map it to a custom long text Oomnitza field, such as API Response. When you have the response, you can map individual JSON values to the custom fields as shown in the screen capture.
   

See Quip API documentation: Get User.

Quip Add User To Folder

The Quip Add User To Folder preset adds a user to a Quip folder. When you create the workflow, you must provide the Quip Folder ID and Quip User ID.

Tip
You can get the folder ID by running the Quip Create Folder preset. You can call this field directly in the API block by entering {{quip_folder_id}} in the Folder ID field. You can get the Quip User ID by running the user integration or the Quip Create Folder preset. You can call this field directly in the API block by entering {{quip_user_id}} in the User ID field.

You can use the Advanced Mode to configure the message response. To do this, complete the following steps:

1. In the API block tab, click Advanced Mode.
   1. Select the RESPONSE tab. To map the entire response enter {{response}} in the Response field and map it to a custom long text Oomnitza field, such as API Response. When you have the response, you can map individual JSON values to the custom fields as shown in the screen capture.
2. 

See Quip API documentation: Add People to a Folder.

Quip Remove User

The Quip Remove User From Folder preset removes a user from a Quip folder. When creating the workflow, you must provide the Folder ID and the ID of the user you want to add.

You can use the Advanced Mode to configure the message response. To do this, complete the following steps:

1. 1. In the API block tab, click the Advanced Mode button located in the upper right of the window.
   2. In the RESPONSE tab, you can map the entire response by placing {{response}} in the Response field and mapping it to a custom Oomnitza long text field. Then you can map individual JSON values to custom fields, as shown in the screen capture for the Quip Add User TO Folder preset.

See Quip API documentation: Remove people from a folder.