Skip to content

Commit a95e98f

Browse files
committed
Update README file.
1 parent d0d6347 commit a95e98f

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

components/docugenerate/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,25 @@ The DocuGenerate API lets you automate document creation and management tasks wi
99
- **Automated Report Creation and Distribution**: Schedule a workflow to run weekly, gathering data from tools such as Google Sheets or a database. Use this data to create a tailored report via DocuGenerate and subsequently email the report to a list of stakeholders using an email service like SendGrid.
1010

1111
- **Dynamic Invoice Creation from E-Commerce Platforms**: When a new order is placed on an e-commerce platform (like Shopify), trigger a Pipedream workflow that creates an invoice through the DocuGenerate API. Then, archive the invoice in cloud storage like Google Drive and update the order status within the e-commerce platform.
12+
13+
# Getting Started
14+
15+
## Obtaining Your API Key
16+
17+
1. Sign up for a [DocuGenerate](https://www.docugenerate.com/) account
18+
2. Get your unique API Key from the Developers tab in the [Settings](https://app.docugenerate.com/settings/developers) page
19+
5. Copy the API Key for use in Pipedream
20+
21+
## Connecting to Pipedream
22+
23+
1. In your Pipedream workflow, add a DocuGenerate action
24+
2. When prompted for authentication, paste your API Key
25+
3. Test the connection by using the "List Templates" action
26+
27+
## Generating Your First Document
28+
29+
Use the "Generate Document" action with:
30+
- **Template**: Select from your available templates
31+
- **Data**: Provide JSON data matching your template merge tags (e.g., `{ "name": "John Doe" }`)
32+
- **Name**: Set a custom document name (optional)
33+
- **Format**: Choose your desired output format (optional)

0 commit comments

Comments
 (0)