How to Set Up Webhook Notifications?

 What is a Webhook?

A webhook is a simple way for one application to automatically send real-time data to another when a specific event happens. Think of it as an automatic notification — when something important occurs (like a ticket purchase, a payment, or a new user registration), Tikkl can instantly send the details to your system without you having to ask for it.

Unlike traditional APIs, where your system would have to keep checking for updates, webhooks push the information to you as soon as the event occurs, making your workflows faster and more efficient.

Step 1: Set up Webhook at the Organization Level

1. Navigate to the Organization Settings > Webhook section.
2. Check the box labelled "Enable webhook".
3. Fill in the following required fields:
   • Webhook URL
     Enter the public endpoint where your server can receive POST requests.
     Example: https://yourdomain.com/webhook/tikkl
   • Webhook Secret
     Enter a secure secret string that will be used to generate a signature to help you verify the authenticity of the webhook requests.
4. Click the "Save" button to confirm your settings.

🛡️ Security Tip: Use the Webhook Secret to verify payloads on your server using HMAC (SHA-256). Each event will include a signature header for validation.

Step 2: Enable Webhook for Specific Campaigns

Webhook delivery is campaign-specific. This gives you control over which events should trigger notifications.

1. Go to the Campaign Settings page of the desired event campaign.
2. Scroll down to the Webhook Notifications section.
3. Check the box labelled "Enable Webhook notifications for this campaign."
4. Select the webhook events you want to listen for:
   • ✅ New sales transaction
   • ✅ Ticket purchase

Only the selected events will trigger webhook posts.

📤 Webhook Request Format

• HTTP Method: POST
• Content-Type: application/json
• Headers:
  • X-Tikkl-Signature: HMAC SHA-256 signature of the JSON body using your webhook secret

📦 Webhook Payload Details

Tikkl sends JSON payloads in the request body when a webhook event is triggered. The structure of this data depends on the event type you selected.

1. New sales transaction Payload

This event is triggered when a new transaction is created (e.g., someone places an order with one or more tickets).

Payload Example:

{
"objectType": "transaction",
"orderId": "123-45678901-2345678",
"orgName": "Awesome Org",
"orgSubdomain": "awesomeorg",
"campaignName": "Tech Conference 2025",
"campaignUrl": "https://tikkl.com/awesomeorg/c/tech-conf",
"orderUrl": "https://tikkl.com/awesomeorg/admin/c/tech-conf/participation/123-45678901-2345678",
"orderTimeUtc": "2025-06-22T14:45:30Z",
"ticketCount": 2,
"userName": "Jane Doe",
"userEmail": "[e-mail]",
"userPhone": "[phone]"
} 

2. Ticket purchase (Product Sale) Payload

This event is triggered when an individual ticket is issued (useful for tracking registrant-level activity).

Payload Example:

{
"objectType": "ticket",
"ticketId": "123-45678901-2345678-001",
"orderId": "123-45678901-2345678",
"orgName": "Awesome Org",
"orgSubdomain": "awesomeorg",
"campaignName": "My Tech Conference",
"campaignUrl": "https://tikkl.com/awesomeorg/c/tech-conf",
"orderUrl": "https://tikkl.com/awesomeorg/admin/c/tech-conf/participation/123-45678901-2345678",
"eventName": "My Tech Conference",
"orderTimeUtc": "2025-06-22T14:45:30Z",
"registrantName": "John Smith",
"registrantEmail": "[e-mail]"
}