Piggy integration

Claim Anonymous Contact

Tool 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.

Create Contact Attribute

Tool to create a custom Contact Attribute. Use when you need to define new fields for contacts after initial setup.

Create Credit Reception

Tool to create a credit reception for a contact. Use when awarding credits to customers based on purchases or fixed amounts.

Create Vouchers Batch

Tool 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.

Find or Create Products

Tool 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.

Find Voucher By Code

Tool to find a voucher by its unique code. Use when you need to retrieve voucher details, check redemption status, or validate a voucher code.

Get Contact Auth Token

Tool to get an auth token for a Contact. Use after obtaining a Contact UUID and needing to verify identity for secure operations.

Get Contact's Credit Balance

Tool to get a Contact's credit balance. Use when you need to check a contact's current credit balance before processing rewards or promotions.

List Forms

Tool to list all forms in the Piggy account. Use when you need to retrieve available forms for customer interactions.

List Perks

Tool 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.

Merge Contacts

Merges 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 …

Send Contact Verification Email

Send 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…