This is a Singer tap that produces JSON-formatted data following the Singer spec for Pipefy.

This tap:

• Pulls data from Pipefy's API for a given organization_id

• Extracts the following resources from Pipefy

  • Members: These are the users of the Pipefy application that are members of the organization.
  • Pipes: This includes all the pipe phases and their fields (if any).
  • Cards: This includes all cards and their nested objects (assignees, comments, fields, labels, and phases history).
  • Tables: This includes all tables, their fields, and the associated table records.

• Outputs the schema for each resource. The tap will dynamically generate a schema for each of the tables. The stream name of each table is table_<table id> where <table id> is the unique table identifier assigned by Pipefy.

  Although this ID is not needed as an input to the tap, you can find it in the Pipefy user interface by going to the table object and extracting the ID from the URL. For example, the table_id is g3TOB3hc in the following URL https://app.pipefy.com/database_v2/tables/g3TOB3hc-test-table-2

• Sync all objects (full replication, incremental sync is not supported)

Quick start

1. Install

This tap requires Python 3. It is recommended that you run it inside it's own virtualenv.

```bash
> virtualenv -p python3 tap-pipefy
> ./tap-pipefy/pip install tap-pipefy
```

2. Get your Pipefy Personal Access Token (API Key)

   Login to your Pipefy account, navigate to your user settings and then to the "personal access tokens" section. Generate a New Token, you'll need it for the next step. Direct Link to Personal Access Tokens

3. Create the config file

   Create a JSON file called config.json containing the personal access token you just generated and your organization ID. You can get your organization ID from the main URL of your Pipefy web application. For example: https://app.pipefy.com/organizations/123456

   {
       "personal_access_token": "your-pipefy-personal-access-token",
       "organization_id": 123456
   }

4. Discover and Catalog

   Use the discover flag to explore the schema for each of this tap's resources

   > ./tap-pipefy/bin/tap-pipefy --config config.json --discover

   Pipe the output of this file to a file that will serve as the catalog, where you will select which streams and properties to sync

   > ./tap-pipefy/bin/tap-pipefy --config config.json --discover > catalog.json

   The catalog is an object with a key streams that has an array of the streams for this tap. For each stream you want to sync, add a "selected": true property on the stream object. Below is an example of how you would select to sync the contacts stream. This property is recursive so it will select all children. If you don't want to sync a property, you can add "selected": false on that property.

           {
           "schema": {
               "properties": {...},
               "type": "object",
               "selected": true
           },
           "stream": "members",
           "tap_stream_id": "members"
       }

5. [Optional] Add additional optional config parameters

   You can include a user_agent key in your config.json to further customize the behavior of this Tap.

   • user_agent should be set to something that includes a contact email address should the API provider need to contact you for any reason.

   If you were to use the user_agent, your complete config.json should look something like this.

   {
     "personal_access_token": "your-pipefy-personal-access-token",
     "organization_id": 123456,
     "user_agent": "My Company (+support@example.com)"
   }

6. Run the application

   tap-pipefy can be run with:

   ./tap-pipefy/bin/tap-pipefy --config config.json --catalog catalog.json

---

Copyright © 2017