Documentation Index

Fetch the complete documentation index at: https://docs.streamkap.com/llms.txt

Use this file to discover all available pages before exploring further.

​

Overview

​

Prerequisites

• A Zendesk account with Admin permissions (required to create webhooks and event subscriptions).
• A Streamkap workspace with permission to create source connectors.
• A clear list of the Zendesk objects you want to capture (tickets, users, organizations, etc.).

​

How It Works

1. Endpoint provisioning — When you create the source, Streamkap generates a unique HTTPS webhook URL and an API key.
2. Zendesk subscription — In Zendesk, you create a webhook target pointing at that URL and subscribe it to the event types you care about.
3. Event routing — Each incoming event carries a type field (for example zen:event-type:ticket.created). The Zendesk payload router maps the event domain to a topic — ticket.* events go to ticket_events, user.* events go to user_events, and so on.
4. Key extraction — The router pulls a stable identifier from the payload (typically detail.id) and uses it as the Kafka message key, enabling upsert-style consumption downstream.
5. Optional flattening / fan-out — Nested detail fields can be promoted to top level, and array fields (such as ticket tags or custom fields) can be fanned out into their own topics.

​

Streamkap Setup

​

1. Create the Source

1. Navigate to Sources and choose Zendesk Webhook.
2. Give the source a memorable Name (for example, zendesk-prod).

​

2. Connection Settings (Auth tab)

​

3. Schema (Zendesk Models)

​

4. Settings

​

5. Save and Copy the Endpoint

​

Zendesk Setup

​

1. Create the Webhook in Zendesk

1. In Zendesk, go to Admin Center → Apps and integrations → Webhooks → Webhooks.
2. Click Create webhook.
3. Choose Trigger or automation (or Zendesk events — see step 2 below).
4. Configure the webhook:
   • Name — Streamkap (or anything memorable).
   • Endpoint URL — paste the Webhook URL from Streamkap.
   • Request method — POST.
   • Request format — JSON.
   • Authentication — choose API key:
     • Header name — X-API-Key
     • Value — paste the API Key from Streamkap.
5. Click Test webhook to confirm Zendesk can reach the endpoint, then Create webhook.

​

2. Subscribe to Event Types

1. In Admin Center, go to Apps and integrations → Webhooks → Connections.
2. Click Create connection, pick the webhook you just created, and select the event types you want to forward.
3. Use event types from the families that match the topics you enabled in Streamkap:
   • zen:event-type:ticket.*
   • zen:event-type:user.*
   • zen:event-type:organization.*
   • zen:event-type:article.*
   • zen:event-type:community_post.*
   • zen:event-type:messaging_ticket.*
   • zen:event-type:agent.*
   • zen:event-type:omnichannel_config.*
   • zen:event-type:messaging_live_metrics.*
4. Save the connection. Zendesk now begins POSTing events to Streamkap.

​

Event Routing Reference

​

Fan-out

ticket.tags,ticket.custom_fields,ticket.comments,ticket.collaborators,ticket.followers,organization.tags

• detail_id — parent entity ID (matches the key field name).
• _ctx_event_id — the originating webhook event UUID, useful for correlating fan-out records back to the parent event.

{
  "value": "urgent",
  "detail_id": 987654,
  "_ctx_event_id": "01HF6...-event-uuid"
}

​

Example Payload

{
  "type": "zen:event-type:ticket.created",
  "id": "01HF6...-event-uuid",
  "account_id": 123456,
  "time": "2026-01-24T15:30:00Z",
  "subject": "zen:ticket:987654",
  "detail": {
    "id": 987654,
    "subject": "Cannot login",
    "status": "new",
    "tags": ["urgent", "billing"],
    "custom_fields": [{ "id": 123, "value": "tier1" }]
  },
  "event": {
    "comment": { "id": 555, "body": "We are looking into it" }
  }
}

{
  "type": "zen:event-type:ticket.created",
  "account_id": 123456,
  "time": "2026-01-24T15:30:00Z",
  "subject": "zen:ticket:987654",
  "detail_id": 987654,
  "detail_subject": "Cannot login",
  "detail_status": "new",
  "__deleted": false
}

​

Common Patterns

​

State table (upsert) ingestion

• Flatten Detail Fields — true
• Include Event Field — false
• Fan-out Fields — list any nested arrays you want as separate tables (typically ticket.tags, ticket.custom_fields)

​

Audit log ingestion

• Flatten Detail Fields — false
• Include Event Field — true
• Fan-out Fields — empty

​

Troubleshooting

​

Limitations

• The Zendesk Webhook source is currently Beta.
• The connector accepts only POST requests; do not configure Zendesk to use a different HTTP method.
• Maximum payload size is 50 MB and maximum header size is 64 KB. Zendesk events fit comfortably within these limits.
• Each request is treated as a single Kafka record. Zendesk does not batch events into one request.
• The connector runs as a single task; horizontal scaling requires multiple source instances.

​

See Also

• Webhook Source — generic webhook source for any HTTP-capable producer.