About this integration
Direct mail and print automation API for sending letters and postcards. Connect it to any workflow without writing code.
You can choose from 1 trigger, 4 search modules and 5 actions. The connection type is basic authentication. Webhook-based triggers fire instantly without polling.
How to connect
The credential form asks for API Key.
Prefer the interactive builder form? Open it on the app page.
Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.
| Field | Type | Help |
|---|---|---|
API KeyRequired | password | You can obtain your Postgid API Key using the following instruction: https://postgrid.readme.io/docs/overview. |
Use it in workflow automation
Start with Watch Events, then add Cancel a Postcard.
The canvas below runs Watch Events into Cancel a Postcard — watch the video, then drop a node onto the canvas.
Select the Watch Events trigger and the workflow fires automatically when the event occurs — no polling required.
Then add Create a Contact as the next node. Branch, filter, or hand off to other integrations from there.
The integration includes 6 ready-made modules for marketing work — each run logs its inputs and outputs for debugging.
Postgrid workflow on the canvas: Watch Events then Create a Contact
Triggers, searches and actions
Explore the fields available for each Postgrid trigger, search, and action — 1 trigger, 4 searchs, and 5 actions.
Triggers
Whenever something changes in the app, one of 1 available trigger can start a run immediately.
- Watch Events
Searches
4 search modules let you query the app mid-run and feed the results to the next step.
- Get a Contact
- Get a Postcard
- Search Contacts
- Search Postcards
Actions
Use 5 action modules to write data back into the app from anywhere in a run.
- Cancel a Postcard
- Create a Contact
- Create a Postcard
- Delete a Contact
- Make an API Call
Explore the fields available for each Postgrid trigger, search, and action.
Triggers
| Field | Type |
|---|---|
User ID | number |
Email address | |
Name | text |
Date created | date |
Searches
| Field | Type |
|---|---|
Contact IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Live | boolean |
Address Line 1 | text |
Address Line 2 | text |
Address Status | text |
City | text |
Company Name | text |
Country | text |
Country Code | text |
First Name | text |
Postal or ZIP | text |
Province Or State | text |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Postcard IDRequired | choice |
Expand | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Live | boolean |
Page Count | number |
Send Date | date |
Size | text |
Status | text |
To | object |
ID | text |
Object | text |
Address Line 1 | text |
Address Line 2 | text |
Address Status | text |
City | text |
Country | text |
Country Code | text |
First Name | text |
Postal Or Zip | text |
Uploaded PDF | url |
URL | url |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Search | text |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Live | boolean |
Address Line 1 | text |
Address Line 2 | text |
Address Status | text |
City | text |
Company Name | text |
Country | text |
Country Code | text |
First Name | text |
Postal or ZIP | text |
Province Or State | text |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Search | text |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Live | boolean |
Page Count | number |
Send Date | date |
Size | text |
Status | text |
To | object |
ID | text |
Object | text |
Address Line 1 | text |
Address Line 2 | text |
Address Status | text |
City | text |
Country | text |
Country Code | text |
First Name | text |
Postal Or Zip | text |
Uploaded PDF | url |
URL | url |
Created at | date |
Updated at | date |
Actions
| Field | Type |
|---|---|
Contact IDRequired | choice |
| Field | Type |
|---|---|
Address Line 1Required | text |
Country CodeRequired | text |
First Name | text |
Last Name | text |
Company Name | text |
Address Line 2 | text |
City | text |
Province or State | text |
Email | |
Phone Number | text |
Job Title | text |
Postal or Zip | text |
Description | text |
Metadata | array |
Key NameRequired | text |
ValueRequired | text |
Skip Verification | boolean |
Force Verified Status | boolean |
| Field | Type |
|---|---|
ID | text |
Object | text |
Live | boolean |
Address Line 1 | text |
Address Line 2 | text |
Address Status | text |
City | text |
Company Name | text |
Country | text |
Country Code | text |
First Name | text |
Postal or ZIP | text |
Province Or State | text |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
ToRequired | choice |
PDFRequired | text |
SizeRequired | choice |
From | text |
Send Date | date |
Express | boolean |
Description | text |
Mailing Class | choice |
Merge Variable Language | text |
Metadata | array |
Key NameRequired | text |
ValueRequired | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Live | boolean |
Page Count | number |
Send Date | date |
Size | text |
Status | text |
To | object |
ID | text |
Object | text |
Address Line 1 | text |
Address Line 2 | text |
Address Status | text |
City | text |
Country | text |
Country Code | text |
First Name | text |
Postal Or Zip | text |
Uploaded PDF | url |
URL | url |
Created at | date |
Updated at | date |
| Field | Type |
|---|---|
Contact IDRequired | choice |
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
| Field | Type |
|---|---|
Body | text |
Headers | object |
Status code | number |