How to create API integrations on Zendesk
Create API integrations in Zendesk by accessing Admin Center, navigating to Apps and integrations, then setting up HTTP targets or webhooks with proper authentication. Configure endpoints, headers, and JSON payloads to connect Zendesk with external services.
Prerequisites
- Zendesk administrator access
- Basic understanding of REST APIs
- Target application API credentials
- Knowledge of JSON format
Step-by-Step Instructions
Access Zendesk Admin Center
Choose Integration Type
- HTTP Targets - For sending data to external APIs
- Webhooks - For real-time event notifications
- Extensions - For custom integrations
Configure Connection Details
- Title: Descriptive name for your integration
- URL: Target API endpoint (e.g.,
https://api.example.com/webhooks) - Method: HTTP method (GET, POST, PUT, DELETE)
- Content type: Usually
application/json
Set Up Authentication
- Basic authentication: Enter username and password
- Bearer token: Add API token in format
Bearer your_token_here - API key: Add as header or query parameter
Design JSON Payload
{
"ticket_id": "{{ticket.id}}",
"status": "{{ticket.status}}",
"subject": "{{ticket.title}}",
"requester_email": "{{ticket.requester.email}}"
}Use liquid markup for dynamic content and conditional logic.Test the Integration
Create Triggers or Automations
Monitor and Maintain
Common Issues & Troubleshooting
HTTP 401 Unauthorized errors
Verify API credentials are correct and not expired. Check that authentication headers are properly formatted and the API key has sufficient permissions in the target system.
HTTP 400 Bad Request responses
Review JSON payload syntax and ensure all required fields are included. Validate that Zendesk placeholders are resolving to expected values using the test feature.
Integration not triggering
Check trigger conditions in Business rules and verify they match your test scenarios. Ensure the trigger is active and the target is properly selected in the actions section.
Timeout errors
Verify the target endpoint is responding within Zendesk's timeout limits (typically 30 seconds). Check network connectivity and consider optimizing the target application's response time.