Webhooks Overview

Receive real-time notifications when events occur in your workspace.

What Are Webhooks?

Webhooks are HTTP callbacks that notify your application when something happens in cStar. Instead of polling the API, webhooks push data to you instantly.

Use Cases

  • Sync with CRM - Create CRM records when customers are added
  • Slack notifications - Alert your team when high-priority tickets arrive
  • Analytics - Track ticket resolution times in your data warehouse
  • Automation - Trigger workflows in Zapier, Make, or n8n

How It Works

  1. You register a webhook URL in cStar
  2. You subscribe to specific events (e.g., ticket.created)
  3. When an event occurs, cStar sends an HTTP POST to your URL
  4. Your server processes the payload and returns 200 OK

Quick Setup

1. Create a Webhook

Go to Settings → Integrations → Webhooks and click Create Webhook.

2. Configure Your Endpoint

  • URL: Your HTTPS endpoint (must be publicly accessible)
  • Events: Select which events to receive
  • Name: A descriptive name for reference

3. Save the Secret

After creation, copy the signing secret. You'll need it to verify webhook signatures.

Payload Format

Every webhook delivery includes:

{
  "id": "evt_abc123def456",
  "type": "ticket.created",
  "created_at": "2025-12-14T10:30:00Z",
  "team_id": "ffce2c0d-a0c8-4285-a55f-c674f191feb0",
  "data": {
    "ticket": {
      "id": "tkt_123",
      "title": "Need help with billing",
      "priority": "high",
      "status": "new"
    }
  }
}

Request Headers

POST /your-webhook-endpoint HTTP/1.1
Content-Type: application/json
X-Webhook-ID: wh_abc123
X-Event-Type: ticket.created
X-Event-ID: evt_abc123def456
X-Timestamp: 2025-12-14T10:30:00Z
X-Signature: sha256=abc123...
X-Delivery-Attempt: 1
User-Agent: cStar-Webhooks/1.0

Responding to Webhooks

Your endpoint should:

  1. Return 200 OK within 30 seconds
  2. Process async if needed (return 200 immediately, process later)
  3. Be idempotent (same event may be delivered multiple times)

Testing Webhooks

Use the Test button in webhook settings to send a sample event. This helps verify your endpoint is working before real events flow.

Automation Platforms

cStar webhooks are compatible with:

  • Zapier - Use REST Hooks or catch webhooks
  • Make (Integromat) - Use the webhook module
  • n8n - Use the webhook trigger node

Next Steps