# Piggy

```json
{
  "name": "Piggy",
  "slug": "piggy",
  "url": "https://composio.dev/toolkits/piggy",
  "markdown_url": "https://composio.dev/toolkits/piggy.md",
  "logo_url": "https://cdn.jsdelivr.net/gh/ComposioHQ/open-logos@master//piggy.png",
  "categories": [
    "marketing & social media"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-05-12T10:21:56.571Z"
}
```

![Piggy logo](https://cdn.jsdelivr.net/gh/ComposioHQ/open-logos@master//piggy.png)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Piggy MCP or direct API to automate loyalty rewards, issue cashback, track points, and engage customers through natural language.

## Summary

Piggy is a loyalty and cashback platform for online stores, letting users earn points or discounts. It helps businesses boost repeat purchases and customer retention.

## Categories

- marketing & social media

## Toolkit Details

- Tools: 14

## Images

- Logo: https://cdn.jsdelivr.net/gh/ComposioHQ/open-logos@master//piggy.png

## Authentication

- **Api Key**
  - Type: `api_key`
  - Description: Api Key authentication for Piggy.
  - Setup:
    - Configure Api Key credentials for Piggy.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- Check my current Piggy loyalty points
- Redeem points for a store discount
- List recent cashback transactions
- Show available loyalty rewards for me

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `PIGGY_CLAIM_ANONYMOUS_CONTACT` | 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. |
| `PIGGY_CREATE_CONTACT_ATTRIBUTE` | Create Contact Attribute | Tool to create a custom Contact Attribute. Use when you need to define new fields for contacts after initial setup. |
| `PIGGY_CREATE_CREDIT_RECEPTION` | Create Credit Reception | Tool to create a credit reception for a contact. Use when awarding credits to customers based on purchases or fixed amounts. |
| `PIGGY_CREATE_VOUCHERS_BATCH` | 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. |
| `PIGGY_FIND_OR_CREATE_PRODUCTS` | 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. |
| `PIGGY_FIND_VOUCHER_BY_CODE` | 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. |
| `PIGGY_GET_CONTACT_AUTH_TOKEN` | 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. |
| `PIGGY_GET_CONTACTS_CREDIT_BALANCE` | 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. |
| `PIGGY_LIST_FORMS` | List Forms | Tool to list all forms in the Piggy account. Use when you need to retrieve available forms for customer interactions. |
| `PIGGY_LIST_PERKS` | 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. |
| `PIGGY_MERGE_CONTACTS` | 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 duplicate customer records. |
| `PIGGY_SEND_CONTACT_VERIFICATION_EMAIL` | 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 access the Contacts Portal. |
| `PIGGY_UPDATE_BOOKINGS` | 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. |
| `PIGGY_UPDATE_CONTACT_IDENTIFIERS` | 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. |

## Supported Triggers

None listed.

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK
```python
pip install composio_openai
```

```typescript
npm install @composio/openai
```

#### Path 1, Step 2: Initialize Composio and Create Tool Router Session

Import and initialize Composio client, then create a Tool Router session
```python
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
openai = OpenAI()
session = composio.create(user_id='your-user-id')
```

```typescript
import OpenAI from 'openai';
import { Composio } from '@composio/core';
import { OpenAIResponsesProvider } from '@composio/openai';

const composio = new Composio({
  provider: new OpenAIResponsesProvider(),
});
const openai = new OpenAI({});
const session = await composio.create('your-user-id');
```

#### Path 1, Step 3: Execute Piggy Tools via Tool Router with Your Agent

Get tools from Tool Router session and execute Piggy actions with your Agent
```python
tools = session.tools
response = openai.responses.create(
  model='gpt-4.1',
  tools=tools,
  input=[{
    'role': 'user',
    'content': 'Show customers who earned the most loyalty points this month'
  }]
)
result = composio.provider.handle_tool_calls(
  response=response,
  user_id='your-user-id'
)
print(result)
```

```typescript
const tools = session.tools;
const response = await openai.responses.create({
  model: 'gpt-4.1',
  tools: tools,
  input: [{
    role: 'user',
    content: 'Show customers who earned the most loyalty points this month'
  }],
});
const result = await composio.provider.handleToolCalls(
  'your-user-id',
  response.output
);
console.log(result);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK and Claude Agent SDK
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/openai @ai-sdk/mcp
```

#### Path 2, Step 2: Create Tool Router Session

Initialize the Composio client and create a Tool Router session
```python
from composio import Composio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

composio = Composio(api_key='your-composio-api-key')
session = composio.create(user_id='your-user-id')
url = session.mcp.url
```

```typescript
import { Composio } from '@composio/core';

const composio = new Composio({ apiKey: 'your-api-key' });

console.log("Creating Tool Router session...");
const { mcp } = await composio.create('your-user-id');
console.log(`Tool Router session created: ${mcp.url}`);
```

#### Path 2, Step 3: Connect to AI Agent

Use the MCP server with your AI agent
```python
import asyncio

options = ClaudeAgentOptions(
    permission_mode='bypassPermissions',
    mcp_servers={
        'tool_router': {
            'type': 'http',
            'url': url,
            'headers': {
                'x-api-key': 'your-composio-api-key'
            }
        }
    },
    system_prompt='You are a helpful assistant with access to Piggy tools.',
    max_turns=10
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query('Show customers who earned the most loyalty points this month')
        async for message in client.receive_response():
            if hasattr(message, 'content'):
                for block in message.content:
                    if hasattr(block, 'text'):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { openai } from '@ai-sdk/openai';
import { experimental_createMCPClient as createMCPClient } from '@ai-sdk/mcp';
import { generateText, stepCountIs } from 'ai';

const client = await createMCPClient({
  transport: {
    type: 'http',
    url: mcp.url,
    headers: { 'x-api-key': 'your-composio-api-key' }
  }
});

const tools = await client.tools();

const { text } = await generateText({
  model: openai('gpt-4o'),
  tools,
  messages: [{ role: 'user', content: 'Show customers who earned the most loyalty points this month' }],
  stopWhen: stepCountIs( 5 )
});

console.log(`Agent: ${text}`);
```

## Why Use Composio?

### 1. AI Native Piggy Integration

- Supports both Piggy MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable tool execution
- Rich coverage for reading, writing, and querying your Piggy data

### 2. Managed Auth

- Built-in API Key management without hard-coding credentials
- Central place to manage and revoke Piggy access
- Per user and per environment credentials for better security

### 3. Agent Optimized Design

- Tools are tuned using real error and success rates to improve reliability over time
- Comprehensive execution logs so you always know what ran, when, and on whose behalf

### 4. Enterprise Grade Security

- Fine-grained RBAC so you control which agents and users can access Piggy
- Scoped, least privilege access to Piggy resources
- Full audit trail of agent actions to support review and compliance

## Use Piggy with any AI Agent Framework

Choose a framework you want to connect Piggy with:

- [OpenAI Agents SDK](https://composio.dev/toolkits/piggy/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/piggy/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/piggy/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/piggy/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/piggy/framework/codex)
- [OpenClaw](https://composio.dev/toolkits/piggy/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/piggy/framework/hermes-agent)
- [Google ADK](https://composio.dev/toolkits/piggy/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/piggy/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/piggy/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/piggy/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/piggy/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/piggy/framework/crew-ai)
- [Pydantic AI](https://composio.dev/toolkits/piggy/framework/pydantic-ai)
- [AutoGen](https://composio.dev/toolkits/piggy/framework/autogen)

## Related Toolkits

- [Reddit](https://composio.dev/toolkits/reddit) - Reddit is a social news platform with thriving user-driven communities (subreddits). It's the go-to place for discussion, content sharing, and viral marketing.
- [Facebook](https://composio.dev/toolkits/facebook) - Facebook is a social media and advertising platform for businesses and creators. It helps you connect, share, and manage content across your public Facebook Pages.
- [Linkedin](https://composio.dev/toolkits/linkedin) - LinkedIn is a professional networking platform for connecting, sharing content, and engaging with business opportunities. It's the go-to place for building your professional brand and unlocking new career connections.
- [Active campaign](https://composio.dev/toolkits/active_campaign) - ActiveCampaign is a marketing automation and CRM platform for managing email campaigns, sales pipelines, and customer segmentation. It helps businesses engage customers and drive growth through smart automation and targeted outreach.
- [ActiveTrail](https://composio.dev/toolkits/active_trail) - ActiveTrail is a user-friendly email marketing and automation platform. It helps you reach subscribers and automate campaigns with ease.
- [Ahrefs](https://composio.dev/toolkits/ahrefs) - Ahrefs is an SEO and marketing platform for site audits, keyword research, and competitor insights. It helps you improve search rankings and drive organic traffic.
- [Amcards](https://composio.dev/toolkits/amcards) - AMCards lets you create and mail personalized greeting cards online. Build stronger customer relationships with easy, automated card campaigns.
- [Beamer](https://composio.dev/toolkits/beamer) - Beamer is a news and changelog platform for in-app announcements and feature updates. It helps companies boost user engagement by sharing news where users are most active.
- [Benchmark email](https://composio.dev/toolkits/benchmark_email) - Benchmark Email is a platform for creating, sending, and tracking email campaigns. It's built to help you engage audiences and analyze results—all in one place.
- [Bigmailer](https://composio.dev/toolkits/bigmailer) - BigMailer is an email marketing platform for managing multiple brands with white-labeling and automation. It helps teams streamline campaigns and simplify integration with Amazon SES.
- [Brandfetch](https://composio.dev/toolkits/brandfetch) - Brandfetch is an API that delivers company logos, colors, and visual branding assets. It helps marketers and developers keep brand visuals consistent everywhere.
- [Brevo](https://composio.dev/toolkits/brevo) - Brevo is an all-in-one email and SMS marketing platform for transactional messaging, automation, and CRM. It helps businesses engage customers and streamline communications through powerful campaign tools.
- [Campayn](https://composio.dev/toolkits/campayn) - Campayn is an email marketing platform for creating, sending, and managing campaigns. It helps businesses engage contacts and grow audiences with easy-to-use tools.
- [Cardly](https://composio.dev/toolkits/cardly) - Cardly is a platform for creating and sending personalized direct mail to customers. It helps businesses break through the digital clutter by getting real engagement via physical mailboxes.
- [ClickSend](https://composio.dev/toolkits/clicksend) - ClickSend is a cloud-based SMS and email marketing platform for businesses. It streamlines communication by enabling quick message delivery and contact management.
- [Crustdata](https://composio.dev/toolkits/crustdata) - CrustData is an AI-powered data intelligence platform for real-time company and people data. It helps B2B sales teams, AI SDRs, and investors react to live business signals.
- [Curated](https://composio.dev/toolkits/curated) - Curated is a platform for collecting, curating, and publishing newsletters. It streamlines content aggregation and distribution for creators and teams.
- [Customerio](https://composio.dev/toolkits/customerio) - Customer.io is a customer engagement platform for targeted messaging across email, SMS, and push. Easily automate, segment, and track communications with your audience.
- [Cutt ly](https://composio.dev/toolkits/cutt_ly) - Cutt.ly is a URL shortening service for managing and analyzing links. Streamline your workflows with quick, trackable, and branded short URLs.
- [Demio](https://composio.dev/toolkits/demio) - Demio is webinar software built for marketers, offering both live and automated sessions with interactive features. It helps teams engage audiences and optimize lead generation through detailed analytics.

## Frequently Asked Questions

### Do I need my own developer credentials to use Piggy with Composio?

Yes, Piggy requires you to configure your own API key credentials. Once set up, Composio handles secure credential storage and API request handling for you.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)