Skip to docs navigation

Cardly integration guide

Verified

How to connect Cardly to WEXTL and use its 1 trigger and 43 actions in your workflows. About Cardly: Preview and send printed greeting cards and letters, and manage artwork and contact lists.

  • 1 trigger
  • 23 searches
  • 20 actions
  • Instant (webhooks)
  • Auth: API key

AI-assisted documentation17 min read

This documentation is compiled from our integration source code, internal specs for Cardly, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Cardly on WEXTL →
  • Cardly
  • WEXTL
  • Ablefy
  • Beamer
  • Basin
  • Birdeye
  • Bloomreach
  • CertSeal
  • Captions
  • Auphonic
  • ActiveTrail
  • ActiveCampaign
  • Buk Capacitaciones
  • Action Network
  • Bitly
  • Bouncer
  • Ahrefs
  • Clipdrop
  • Bumpups
  • Brandfetch
  • APITemplate.io
  • Bannerbear
  • Claid AI
  • Castmagic
  • Clearout
  • Campaign Monitor
  • Bettermode
  • AWeber
  • beehiiv
  • Brandwatch
  • Akeneo
  • API KeypasswordRequired

    In your organisation portal open the API settings and copy a key. Keys starting with test_ never place real orders. Keys starting with live_ do.[1]

  1. Log in to your WEXTL account, add the Cardly node module to your workflow, and click Create new credential.Instant triggers use webhooks. Click Create a webhook first when adding one, then create the credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Cardly account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Watch Events

TriggerInstant trigger for Cardly events.
Output fields[3]
FieldType
Eventtext
Payloadtext

Find a User

SearchAccount search by email address.
Input fields[3]
FieldType
EmailRequired
text
Output fields[3]
FieldType
IDtext
First Nametext
Last Nametext
Emailtext
Statustext
Permissionstext

Find an Invitation

SearchInvitation search by address.
Input fields[3]
FieldType
EmailRequired
text
Output fields[3]
FieldType
IDtext
First Nametext
Last Nametext
Emailtext
Statustext
Permissionstext
Inviteddate
Invite Sentdate
Acceptedtext
Expiresdate
Linksobject
Accepttext

Get a Contact

SearchSingle recipient and their details.
Input fields[3]
FieldType
Contact ListRequired
choice
ContactRequired
choice
Output fields[3]
FieldType
IDtext
External IDtext
Contact List IDtext
Statustext
First Nametext
Last Nametext
Full Nametext
Emailtext
Companytext
Addresstext
Address2text
Localitytext
Admin Area Level1text
Countrytext
Postcodenumber
Latitudenumber
Longitudenumber
Raw Addresstext
Requires Actionboolean
Fieldstext

Get a Contact List

SearchOne recipient list in full.
Input fields[3]
FieldType
Contact ListRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Statustext
Contactsnumber
Automationsnumber
Fieldstext
Rulestext
Validationtext

Get a User

SearchAccess held by one person on the account.
Input fields[3]
FieldType
UserRequired
choice
Output fields[3]
FieldType
IDtext
First Nametext
Last Nametext
Emailtext
Statustext
Permissionstext

Get an Artwork

SearchOne card design in full.
Input fields[3]
FieldType
ArtworkRequired
choice
Output fields[3]
FieldType
IDtext
Revisionnumber
Nametext
Slugtext
Full Pathtext
Descriptiontext
Artworkarray
Mediaobject
IDtext
Nametext
Descriptiontext
Credit Costnumber
Pagesnumber
Dimensionsobject
Bleedobject
Artobject
Created Atdate
Updated Atdate

Get an Invitation

SearchStatus and send dates of one invitation.
Input fields[3]
FieldType
InvitationRequired
choice
Output fields[3]
FieldType
IDtext
First Nametext
Last Nametext
Emailtext
Statustext
Permissionstext
Inviteddate
Invite Sentdate
Acceptedtext
Expiresdate
Linksobject
Accepttext

Get an Order

SearchStatus and cost breakdown of an order.
Input fields[3]
FieldType
OrderRequired
choice
Output fields[3]
FieldType
IDtext
Statustext
Origintext
Customerobject
First Nametext
Last Nametext
Addresstext
Address2text
Citytext
Regiontext
Postcodenumber
Countrytext
Emailtext
Purchase Order Notext
Costsobject
Creditsnumber
Gift Creditnumber
Grossnumber
Discountnumber
Taxnumber
Shippingnumber
Shipping Taxnumber
Totalnumber
Currencytext
Timingsobject
Createddate
Paiddate
Updateddate
Itemsarray
Itemobject

Get the Account Balance

SearchCurrent credit on the account.
Output fields[3]
FieldType
Balancenumber
Gift Creditobject
Balancenumber
Currencytext

List Artwork

SearchDesigns available for cards.
Input fields[3]
FieldType
LimitRequired
number
Own Artwork Onlyboolean
Output fields[3]
FieldType
IDtext
Revisionnumber
Nametext
Slugtext
Full Pathtext
Descriptiontext
Artworkarray
Mediaobject
IDtext
Nametext
Descriptiontext
Credit Costnumber
Pagesnumber
Dimensionsobject
Bleedobject
Artobject
Created Atdate
Updated Atdate

List Contact Lists

SearchRecipient lists on the account.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Statustext
Contactsnumber
Automationsnumber
Fieldstext
Rulestext
Validationtext

List Contacts

SearchRecipients inside a single list.
Input fields[3]
FieldType
Contact ListRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
External IDtext
Contact List IDtext
Statustext
First Nametext
Last Nametext
Full Nametext
Emailtext
Companytext
Addresstext
Address2text
Localitytext
Admin Area Level1text
Countrytext
Postcodenumber
Latitudenumber
Longitudenumber
Raw Addresstext
Requires Actionboolean
Fieldstext

List Credit History

SearchCredit ledger within a time span.
Input fields[3]
FieldType
LimitRequired
number
Effective Afterdate
Effective On or Afterdate
Effective Beforedate
Effective On or Beforedate
Output fields[3]
FieldType
IDtext
Order IDtext
Transaction IDtext
Typetext
Type Codetext
Changenumber
New Balancenumber
Effective Timedate
Notestext

List Doodles

SearchDoodle graphics for card design.
Input fields[3]
FieldType
LimitRequired
number
Organisation Onlyboolean
Output fields[3]
FieldType
IDtext
Nametext
Slugtext
Descriptiontext
Imagetext
Dimensionsobject
Heightnumber
Widthnumber
Restrictedboolean

List Fonts

SearchFonts usable on cards.
Input fields[3]
FieldType
LimitRequired
number
Organisation Onlyboolean
Output fields[3]
FieldType
IDtext
Nametext
Categorytext
Family Variantsnumber
Can Humaniseboolean
Restrictedboolean

List Gift Credit History

SearchGift credit movements within a time span.
Input fields[3]
FieldType
LimitRequired
number
Effective Afterdate
Effective On or Afterdate
Effective Beforedate
Effective On or Beforedate
Output fields[3]
FieldType
IDtext
Order IDtext
Transaction IDtext
Typetext
Type Codetext
Changenumber
Change Netnumber
Change Taxnumber
New Balancenumber
Effective Timedate
Notestext

List Invitations

SearchAccount invitations, filterable by outcome.
Input fields[3]
FieldType
LimitRequired
number
Accepted Onlyboolean
Expired Onlyboolean
Include Acceptedboolean
Output fields[3]
FieldType
IDtext
First Nametext
Last Nametext
Emailtext
Statustext
Permissionstext
Inviteddate
Invite Sentdate
Acceptedtext
Expiresdate
Linksobject
Accepttext

List Media

SearchPrintable formats and their cost in credit.
Input fields[3]
FieldType
LimitRequired
number
Organisation Onlyboolean
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Credit Costnumber
Pagesnumber
Dimensionsobject
Mmobject
Bleedobject
Mmobject
Artobject
Pxobject

List Orders

SearchOrders placed on the account.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Statustext
Origintext
Customerobject
First Nametext
Last Nametext
Addresstext
Address2text
Citytext
Regiontext
Postcodenumber
Countrytext
Emailtext
Purchase Order Notext
Costsobject
Creditsnumber
Gift Creditnumber
Grossnumber
Discountnumber
Taxnumber
Shippingnumber
Shipping Taxnumber
Totalnumber
Currencytext
Timingsobject
Createddate
Paiddate
Updateddate
Itemsarray
Itemobject

List Templates

SearchSaved templates for cards.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Slugtext
Genericboolean
Mediaobject
IDtext
Nametext
Descriptiontext
Credit Costnumber
Pagesnumber
Dimensionsobject
Bleedobject
Artobject
Gift Cardobject
IDtext
Regiontext
Currencytext
Amountnumber
Can Changeboolean
Definitionobject
Versionnumber
Styleobject
Pagesarray
Variablesobject
Created Atdate
Updated Atdate

List Users

SearchAccount holders and their permissions.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
First Nametext
Last Nametext
Emailtext
Statustext
Permissionstext

List Writing Styles

SearchHandwriting styles for messages.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Ordernumber

Search Contacts

SearchFinds recipients by email or external ID.
Input fields[3]
FieldType
Contact ListRequired
choice
Search TermRequired
text
Output fields[3]
FieldType
IDtext
External IDtext
Contact List IDtext
Statustext
First Nametext
Last Nametext
Full Nametext
Emailtext
Companytext
Addresstext
Address2text
Localitytext
Admin Area Level1text
Countrytext
Postcodenumber
Latitudenumber
Longitudenumber
Raw Addresstext
Requires Actionboolean
Fieldstext

Create a Contact

ActionMailing recipient saved into a list.
Input fields[3]
FieldType
Contact ListRequired
choice
First NameRequired
text
AddressRequired
text
CityRequired
text
RegionRequired
text
CountryRequired
text
PostcodeRequired
text
External IDtext
Last Nametext
Emailtext
Companytext
Address Line 2text
Custom Fieldsarray
Fieldobject
Output fields[3]
FieldType
IDtext
External IDtext
Contact List IDtext
Statustext
First Nametext
Last Nametext
Full Nametext
Emailtext
Companytext
Addresstext
Address2text
Localitytext
Admin Area Level1text
Countrytext
Postcodenumber
Latitudenumber
Longitudenumber
Raw Addresstext
Requires Actionboolean
Fieldstext

Create a Contact List

ActionStarts a new recipient list.
Input fields[3]
FieldType
NameRequired
text
Descriptiontext
Custom Fieldsarray
Fieldobject
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Statustext
Contactsnumber
Automationsnumber
Fieldstext
Rulestext
Validationtext

Create an Artwork

ActionCard design built from page images.
Input fields[3]
FieldType
MediaRequired
choice
NameRequired
text
PagesRequired
array
Pageobject
Descriptiontext
Output fields[3]
FieldType
IDtext
Revisionnumber
Nametext
Slugtext
Full Pathtext
Descriptiontext
Artworkarray
Mediaobject
IDtext
Nametext
Descriptiontext
Credit Costnumber
Pagesnumber
Dimensionsobject
Bleedobject
Artobject
Created Atdate
Updated Atdate

Create an Invitation

ActionInvites someone to the account.
Input fields[3]
FieldType
EmailRequired
text
First Nametext
Last Nametext
Permissionschoice
Output fields[3]
FieldType
IDtext
First Nametext
Last Nametext
Emailtext
Statustext
Permissionstext
Inviteddate
Invite Sentdate
Acceptedtext
Expiresdate
Linksobject
Accepttext

Delete a Contact

ActionDeletes a single recipient from its list.
Input fields[3]
FieldType
Contact ListRequired
choice
ContactRequired
choice
Output fields[3]
FieldType
IDtext
External IDtext
Contact List IDtext
Statustext
First Nametext
Last Nametext
Full Nametext
Emailtext
Companytext
Addresstext
Address2text
Localitytext
Admin Area Level1text
Countrytext
Postcodenumber
Latitudenumber
Longitudenumber
Raw Addresstext
Requires Actionboolean
Fieldstext

Delete a Contact by Email or External ID

ActionRemoves a recipient matched by address or external ID.
Input fields[3]
FieldType
Contact ListRequired
choice
Emailtext
External IDtext
Output fields[3]
FieldType
IDtext
External IDtext
Contact List IDtext
Statustext
First Nametext
Last Nametext
Full Nametext
Emailtext
Companytext
Addresstext
Address2text
Localitytext
Admin Area Level1text
Countrytext
Postcodenumber
Latitudenumber
Longitudenumber
Raw Addresstext
Requires Actionboolean
Fieldstext

Delete a Contact List

ActionRemoves a whole recipient list.
Input fields[3]
FieldType
Contact ListRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Statustext
Contactsnumber
Automationsnumber
Fieldstext
Rulestext
Validationtext

Delete a User

ActionRevokes access for one user.
Input fields[3]
FieldType
UserRequired
choice
Output fields[3]
FieldType
IDtext
First Nametext
Last Nametext
Emailtext
Statustext
Permissionstext

Delete a User by Email

ActionRemoves the user holding one address.
Input fields[3]
FieldType
EmailRequired
text
Output fields[3]
FieldType
IDtext
First Nametext
Last Nametext
Emailtext
Statustext
Permissionstext

Delete an Artwork

ActionRemoves one card design.
Input fields[3]
FieldType
ArtworkRequired
choice
Output fields[3]
FieldType
IDtext
Revisionnumber
Nametext
Slugtext
Full Pathtext
Descriptiontext
Artworkarray
Mediaobject
IDtext
Nametext
Descriptiontext
Credit Costnumber
Pagesnumber
Dimensionsobject
Bleedobject
Artobject
Created Atdate
Updated Atdate

Delete an Invitation

ActionRevokes an invitation sent earlier.
Input fields[3]
FieldType
InvitationRequired
choice
Output fields[3]
FieldType
IDtext
First Nametext
Last Nametext
Emailtext
Statustext
Permissionstext
Inviteddate
Invite Sentdate
Acceptedtext
Expiresdate
Linksobject
Accepttext

Delete an Invitation by Email

ActionRevokes the invitation for one address.
Input fields[3]
FieldType
EmailRequired
text
Output fields[3]
FieldType
IDtext
First Nametext
Last Nametext
Emailtext
Statustext
Permissionstext
Inviteddate
Invite Sentdate
Acceptedtext
Expiresdate
Linksobject
Accepttext

Edit a Contact

ActionUpdates a recipient record.
Input fields[3]
FieldType
Contact ListRequired
choice
ContactRequired
choice
First Nametext
Last Nametext
Emailtext
Companytext
External IDtext
Addresstext
Address Line 2text
Citytext
Regiontext
Countrytext
Postcodetext
Custom Fieldsarray
Fieldobject
Clear Fieldschoice
Output fields[3]
FieldType
IDtext
External IDtext
Contact List IDtext
Statustext
First Nametext
Last Nametext
Full Nametext
Emailtext
Companytext
Addresstext
Address2text
Localitytext
Admin Area Level1text
Countrytext
Postcodenumber
Latitudenumber
Longitudenumber
Raw Addresstext
Requires Actionboolean
Fieldstext

Edit an Artwork

ActionUpdates a card design.
Input fields[3]
FieldType
ArtworkRequired
choice
Nametext
Descriptiontext
Pagesarray
Pageobject
Clear Fieldschoice
Output fields[3]
FieldType
IDtext
Revisionnumber
Nametext
Slugtext
Full Pathtext
Descriptiontext
Artworkarray
Mediaobject
IDtext
Nametext
Descriptiontext
Credit Costnumber
Pagesnumber
Dimensionsobject
Bleedobject
Artobject
Created Atdate
Updated Atdate

Generate a Preview

ActionCard mock-up with no order placed.
Input fields[3]
FieldType
ArtworkRequired
choice
RecipientRequired
object
First NameRequired
text
Last Nametext
Companytext
AddressRequired
text
Address Line 2text
CityRequired
text
Regiontext
Postcodetext
CountryRequired
text
Templatechoice
Variablesarray
Variableobject
Message Pagesarray
Pageobject
Styleobject
Alignchoice
Colortext
Fontchoice
Sizenumber
Vertical Alignchoice
Writing Stylechoice
Senderobject
First Nametext
Last Nametext
Companytext
Addresstext
Address Line 2text
Citytext
Regiontext
Postcodetext
Countrytext
Omit Return Addressboolean
Ship to Meboolean
Shipping Methodchoice
Requested Arrivaldate
Output fields[3]
FieldType
Balancenumber
Gift Balanceobject
Balancenumber
Currencytext
Ordertext
Previewtext

Make an API Call

universalCustom Cardly REST API request.
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Keytext
Valuetext
Status codenumber

Place an Order

ActionOrders printed and posted cards.
Input fields[3]
FieldType
LinesRequired
array
Lineobject
Purchase Order Numbertext
Output fields[3]
FieldType
Balancenumber
Gift Balanceobject
Balancenumber
Currencytext
Ordertext

Resend an Invitation

ActionSends one invitation a second time.
Input fields[3]
FieldType
InvitationRequired
choice
Output fields[3]
FieldType
IDtext
First Nametext
Last Nametext
Emailtext
Statustext
Permissionstext
Inviteddate
Invite Sentdate
Acceptedtext
Expiresdate
Linksobject
Accepttext

Resend an Invitation by Email

ActionRe-sends the invite for one address.
Input fields[3]
FieldType
EmailRequired
text
Output fields[3]
FieldType
IDtext
First Nametext
Last Nametext
Emailtext
Statustext
Permissionstext
Inviteddate
Invite Sentdate
Acceptedtext
Expiresdate
Linksobject
Accepttext

Sync a Contact

ActionCreates or updates a recipient by External ID.
Input fields[3]
FieldType
Contact ListRequired
choice
First NameRequired
text
AddressRequired
text
CityRequired
text
RegionRequired
text
CountryRequired
text
PostcodeRequired
text
External IDtext
Last Nametext
Emailtext
Companytext
Address Line 2text
Custom Fieldsarray
Fieldobject
Output fields[3]
FieldType
IDtext
External IDtext
Contact List IDtext
Statustext
First Nametext
Last Nametext
Full Nametext
Emailtext
Companytext
Addresstext
Address2text
Localitytext
Admin Area Level1text
Countrytext
Postcodenumber
Latitudenumber
Longitudenumber
Raw Addresstext
Requires Actionboolean
Fieldstext

Look for Cardly templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Cardly Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Cardly.
  4. WEXTL® visual workflow builder data.

Last updated: Nov 14, 2026 14:55

How we write our apps documentation

How we compile these docs: sources, the role of AI, and how we verify.