Skip to main content
Piggy logo
  • Category: marketing automation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 14
  • Triggers: 0
  • Slug: PIGGY
  • Version: 20261101_00

Tools

Slug: PIGGY_CLAIM_ANONYMOUS_CONTACTTool to claim an anonymous contact by associating it with a real email address. Use when converting an anonymous contact (with a fictional email) into a verified contact with a real email address.

Input Parameters

string
The real email address for the Contact that is about to be not anonymous anymore
string
required
The anonymous Contact’s UUID containing the fictional email address

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIGGY_CREATE_CONTACT_ATTRIBUTETool to create a custom Contact Attribute. Use when you need to define new fields for contacts after initial setup.

Input Parameters

string
required
Unique internal identifier for the Contact Attribute
string
Display label for the Contact Attribute
array
List of options for select or multi_select types. Each option has label and value
string ("url" | "text" | "date" | "phone" | "float" | "color" | "email" | "number" | "select" | "boolean" | "rich_text" | "date_time" | "long_text" | "date_range" | "time_range" | "identifier" | "birth_date" | "file_upload" | "media_upload" | "multi_select" | "license_plate")
required
Data type of the attribute. Determines how values are validated and rendered
string
Human-readable description of the Contact Attribute

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIGGY_CREATE_CREDIT_RECEPTIONTool to create a credit reception for a contact. Use when awarding credits to customers based on purchases or fixed amounts.

Input Parameters

integer
Fixed number of credits to award. Either unit_value or credits must be provided
string
required
UUID of the shop where the transaction occurred
integer
Unit value (e.g., purchase amount in cents) for calculating credits. Either unit_value or credits must be provided
string
required
UUID of the contact to receive credits

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIGGY_CREATE_VOUCHERS_BATCHTool to create a batch of vouchers for a promotion. Use when you need to generate multiple vouchers at once for a specific promotion. Batch processing is asynchronous and returns a PENDING status initially.

Input Parameters

integer
required
The number of Vouchers you want to generate (min: 1, max: 500)
string
The Contact’s UUID to be linked to the batch of Vouchers
string
required
UUID of the Promotion for which the Vouchers are to be created
string
The activation date for the batch of Vouchers in ISO 8601 format
string
The expiration date for the batch of Vouchers in ISO 8601 format
array
Additional Custom Attributes for the Vouchers

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIGGY_FIND_OR_CREATE_PRODUCTSTool to find an existing product by external_identifier or create a new one if it doesn’t exist. Use when you need to ensure a product exists in Piggy’s system for loyalty programs or rewards.

Input Parameters

string
The name of the Product. Required when creating a new product
array
List of Categories that the product belongs to. Each category can be referenced by uuid or external_identifier
string
The description of the Product
string
required
A unique identifier from your system to find or create the product

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIGGY_FIND_VOUCHER_BY_CODEFind a voucher by its unique code and retrieve its details, including available redemption status information.

Input Parameters

string
required
The unique code of the Voucher, which serves as its identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIGGY_GET_CONTACT_AUTH_TOKENTool to get an auth token for a Contact. Use after obtaining a Contact UUID and needing to verify identity for secure operations.

Input Parameters

string
required
UUID of the Contact for which to retrieve an auth token

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIGGY_GET_CONTACTS_CREDIT_BALANCETool to get a Contact’s credit balance. Use when you need to check a contact’s current credit balance before processing rewards or promotions.

Input Parameters

string
required
The UUID of the Contact for which to retrieve the credit balance

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIGGY_LIST_FORMSTool to list all forms in the Piggy account. Use when you need to retrieve available forms for customer interactions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIGGY_LIST_PERKSTool to list all available perks in Piggy. Use when you need to retrieve the catalog of perks that can be associated with contacts or transactions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIGGY_MERGE_CONTACTSMerges a source contact into a destination contact in Piggy’s CRM. The source contact’s data (attributes, balances, transactions) is transferred to the destination contact, and the source contact is removed. This operation is irreversible and processed asynchronously via a job queue. Use this when consolidating duplicate customer records.

Input Parameters

string
required
UUID of the source contact to merge. This contact will be removed after the merge, and all its data will be transferred to the destination contact.
string
required
UUID of the destination contact. This contact will remain active and receive all data from the source contact after the merge.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIGGY_SEND_CONTACT_VERIFICATION_EMAILSend a verification email to a Piggy contact for identity verification. The contact must exist in the system with a configured Contacts Portal. Returns success message with email sent confirmation. Use this when implementing email-based authentication workflows or when contacts need to verify their email address to access the Contacts Portal.

Input Parameters

string
required
Email address of the Contact to send the verification email to. The contact must already exist in the Piggy system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIGGY_UPDATE_BOOKINGSTool to update an existing booking in Piggy. Use when you need to modify booking details such as party size, status, or company name. Note: Shop and contact cannot be updated after creation.

Input Parameters

string
Source from where the Booking was created
string ("created" | "in_progress" | "canceled" | "completed")
Booking status values.
string
The end date and time of the Booking in ISO 8601 format
string
The start date and time of the Booking in ISO 8601 format
string
External identifier for the Booking
string
required
The UUID of the Booking to update
string
Company name associated with the booking
string
The date and time when the party checked into the booking in ISO 8601 format
integer
Amount prepaid (in cents) prior to booking start
integer
Party size for the booking

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIGGY_UPDATE_CONTACT_IDENTIFIERSTool to update a contact identifier in Piggy. Use when you need to modify the display name or active state of an existing contact identifier. Only the name and active properties can be updated; the identifier value itself cannot be changed.

Input Parameters

string
Display name of the contact identifier. Use this to update the human-readable label.
string
required
The unique value of the contact identifier to update. This is the identifier of the contact identifier record itself.
boolean
Active state of the contact identifier. Set to false to deactivate, true to activate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not