About the Pandadoc category

Alumio_Bot · September 21, 2022, 11:08am

Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: PandaDoc API Reference

Connector package documentation

1. Setting up HTTP Client PandaDoc

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client and select PandaDoc HTTP Client as the HTTP Client.
Fill in the Base URI and Authentication Type
(For more information, see PandaDoc Authentication Reference)
You can optionally enable logging of request to get the log of the authentication.
Save the HTTP Client for use.

2. Subscribing to Entities from PandaDoc

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select PandaDoc Subscriber as the subscriber.
Select the PandaDoc HTTP Client to use.
Select the entity you want to subscribe to from PandaDoc.
Add any request parameters needed to subscribe to the entity.
You can optionally add a transformer to transform the request parameters into something you will request from PandaDoc.
You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept

We follow PandaDoc documentation on building this connector, so you can easily use the connector based on PandaDoc API Reference.

HTTP Client

The HTTP Client configuration you will use to access PandaDoc.

Entity

The entity you want to subscribe to PandaDoc. Please refer to the entities from PandaDoc API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on the PandaDoc API Reference.

Please look at the example below on how to fill path field when subscribing “Documents - List Documents” entity.

Based on the documentation, we can see that the end point doesn’t require a path, but we can add query params inside of it. We can set the query params inside the query key in the Request Parameters.

Path is the path parameter of the url. For example the {id}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0

Alumio will then make a request to PandaDoc with the URL /public/v1/documents/folders?parent_uuid=test_123&count=1&page=1

3. Publishing Entity to PandaDoc

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select PandaDoc Publisher as the publisher.
Select the Method that you want the publisher to perform with the data.
Select the PandaDoc entity you want the data to be published to.
You can optionally add any path data to the request on the key path.
You can optionally add any query data to the request on the key query.
You can optionally add any payload data to the request on the key payload.
Select the HTTP Client to use.

3.2 General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer.

Method

Currently, we support HTTP POST method, HTTP PUT method, HTTP PATCH method, and HTTP DELETE method on submitting data to PandaDoc.

Entity

We support publishing to most PandaDoc endpoints.
Please refer to PandaDoc API Reference page.

For example, we want to use “Create Documents Folder”. Please select “POST” as the Action and “Folder - Documents Folders - Create Documents Folder” as the entity of the publisher.

Based on the documentation, it requires a “Request Body”. That is why we set the “Request Body” inside the payload key in the data.

Path is the path parameter of the url. For example the {id}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0
Payload is the data contained within a request.

Alumio will send an API request to PandaDoc with URL /public/v1/documents/folders