Webhook Integration for Keyword
Description
Receives notifications when specified keywords are mentioned on Twitter.
Setup
- Navigate to API & Integrations in your dashboard
- Find the Webhook Integration for Keyword section
- Enter your webhook endpoint URL
- Add the keywords you want to track (comma-separated)
- Click Save to activate
API Configuration
Endpoint: POST https://portfolio.tigest.club/api/v1/twitter/keyword_webhook
Request Payload:
{
"keywords": "keyword1,keyword2,keyword3",
"keyword_webhook_url": "https://your-webhook-endpoint.com/keyword",
"organization_uuid": "3ec8486d-0d51-4bfd-b31b-60c742000247"
}
Success Response:
{
"data": "Keyword webhook created successfully",
"success": true
}
Configuration Parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
keyword_webhook_url | string | Yes | Your endpoint URL | https://your-webhook-endpoint.com/keyword |
keywords | string | Yes | Comma-separated keywords to monitor | keyword1,keyword2,keyword3 |
organization_uuid | string | Yes | Your organization identifier | 3ec8486d-0d51-4bfd-b31b-60c742000247 |
Your Webhook Endpoint
- Method: HTTP POST
- Content-Type:
application/json
Monitored Platform
- Twitter: Real-time monitoring of keyword mentions
Events Tracked
- When any of your specified keywords appear in tweets
- Hashtags and text mentions of your keywords
Subscription Limits
Each subscription tier has limits on keyword webhooks:
- Check your tier limits before adding multiple keyword integrations
Error Response
{
"errors": {
"code": 9000,
"message": "individual tier keyword_webhook limit exceeded: 2/2"
},
"success": false
}
Management Actions
- Edit: Modify webhook URL and tracked keywords
- Delete: Remove the webhook integration
- Test: Send a test payload to verify endpoint
Error Handling
Ensure your webhook endpoint:
- Returns HTTP 200 status for successful processing
- Handles timeouts gracefully
- Implements retry logic if needed
Troubleshooting
Common Issues
- Webhook not receiving data: Verify your URL is accessible and returns HTTP 200
- Subscription limits: Check your tier limits for keyword webhooks
- Invalid organization UUID: Ensure you’re using the correct organization identifier
Testing Your Integration
Use the Test button to send sample data to your endpoint and verify it’s working correctly.
Last updated: May 29, 2025