API_KEY
piggy_api_key
Developer setup
No fields declared in this snapshot.
User connection
- API Keygeneric_api_key · stringRequired
All integrations
PI
Catalogue metadata onlymarketing automationv20260615_00
PIGGY
Piggy
Piggy offers cashback and loyalty program integrations for online stores, letting users earn points or discounts and encouraging repeat purchases
Description is untrusted, display-only upstream metadata. It never becomes policy, OAuth scope authority, or an agent instruction.
Pakkawork boundary
Research catalogue metadata only. No Pakkawork OAuth, credential, host, quota, executor, or verifier is enabled.
No Pakkawork execution adapter is enabled. Hosted account-authorisation availability is workspace-specific and checked separately in the dashboard.Check workspace connection options
Attributed source 14
Action summaries
Display-only definitions
0
Trigger types
Not installed instances
1
Auth modes
Field names, never values
No
Execution
No runtime adapter
Authentication map
What setup is declared?
Only field names, types, and required markers are shown. Secret values, default auth URLs, credential material, and inferred OAuth scopes are excluded.
API_KEY
Provider setup
Capability index
Actions and trigger definitions
Static summaries are available. Live schemas remain disabled until PROVIDER_HUB_API_KEY is configured server-side.
Showing 1–14 of 14 actions
Claim Anonymous Contact
PIGGY_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.
Untrusted display-only summary
Create Contact Attribute
PIGGY_CREATE_CONTACT_ATTRIBUTE
Tool to create a custom Contact Attribute. Use when you need to define new fields for contacts after initial setup.
Untrusted display-only summary
Create Credit Reception
PIGGY_CREATE_CREDIT_RECEPTION
Tool to create a credit reception for a contact. Use when awarding credits to customers based on purchases or fixed amounts.
Untrusted display-only summary
Create Vouchers Batch
PIGGY_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.
Untrusted display-only summary
Find or Create Products
PIGGY_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.
Untrusted display-only summary
Find Voucher By Code
PIGGY_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.
Untrusted display-only summary
Get Contact Auth Token
PIGGY_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.
Untrusted display-only summary
Get Contact's Credit Balance
PIGGY_GET_CONTACTS_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.
Untrusted display-only summary
List Forms
PIGGY_LIST_FORMS
Tool to list all forms in the Piggy account. Use when you need to retrieve available forms for customer interactions.
Untrusted display-only summary
List Perks
PIGGY_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.
Untrusted display-only summary
Merge Contacts
PIGGY_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 consolidating duplic…
Untrusted display-only summary
Send Contact Verification Email
PIGGY_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 email address to ac…
Untrusted display-only summary
Update Bookings
PIGGY_UPDATE_BOOKINGS
Tool 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.
Untrusted display-only summary
Update Contact Identifiers
PIGGY_UPDATE_CONTACT_IDENTIFIERS
Tool 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.
Untrusted display-only summary
Provenance
Versioned facts, explicit trust.
The detail snapshot comes from an attributed MIT-licensed repository revision. Safe local icons use exact-match CC0 Simple Icons symbols; unmatched brands use monograms.
- Repository
- https://github.com/provider-directoryHQ/provider-directory
- Commit
- 85e33f6a81dfe987f6fc3637d48d45052cea8ca5
- Generated
- 2026-09-12
- Trust policy
- untrusted_display_only
Remote text is plain display metadata only. It must never become an agent prompt, execution policy, OAuth grant, or executable instruction.