Developer Guide
Integrate ZyeChat with your application and build custom workflows.
REST API
Use our REST API to programmatically manage campaigns, contacts, and conversations.
typescript
1
2
3
4
5
6
7
8
9
10
11
12
13
// Example: Send an email via API
const response = await fetch('https://api.zyechat.com/v1/emails', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
to: 'user@example.com',
subject: 'Hello from ZyeChat',
html: '<h1>Welcome!</h1>'
})
});Webhooks
Receive real-time notifications when events occur in your ZyeChat account.
json
1
2
3
4
5
6
7
8
9
10
11
12
13
// Webhook payload example
{
"event": "message.received",
"timestamp": "2024-01-15T10:30:00Z",
"data": {
"conversation_id": "conv_123",
"message": "Hello, I need help",
"user": {
"email": "user@example.com",
"name": "John Doe"
}
}
}Available Events
message.receivedmessage.sentconversation.startedconversation.endedlead.createdlead.qualifiedemail.openedemail.clickedSDKs
Official SDKs for popular languages and frameworks:
JavaScript/TypeScript
npm install @zyenova/zyechatPython
pip install zyechatPHP
composer require zyenova/zyechatRuby
gem install zyechatAuthentication
All API requests require authentication using your API key:
// Include in request headers
Authorization: Bearer YOUR_API_KEYRate Limits
Free100 requests/minute
Pro1,000 requests/minute
Business10,000 requests/minute