Webhooks Overview

Webhooks allow you to receive real-time notifications when events occur in your Esca account. When an event happens, we'll send an HTTP POST request to your configured webhook URL with details about the event.

How Webhooks Work

1. You register a webhook endpoint URL in your dashboard
2. You select which events you want to receive
3. When an event occurs, we send an HTTP POST request to your URL
4. Your server processes the event and returns a 2xx response

Setting Up Webhooks

Via Dashboard

1. Log in to your Esca Dashboard
2. Click Developer in the sidebar
3. Go to the Webhooks tab
4. Click Add Endpoint
5. Enter your webhook URL (must be HTTPS in production)
6. Select the events you want to subscribe to
7. Save your endpoint

Testing Webhooks

You can test each webhook event type directly from your Esca account dashboard:

1. Go to the Developer page in your dashboard
2. Navigate to the Webhooks tab
3. Click the Test button icon on the endpoint you want to test
4. A Send Test Webhook modal will appear where you can select the event type to simulate
5. Click send test — a test event will be delivered to your endpoint immediately

This lets you verify your endpoint is configured correctly and your server handles each event type before going live.

Webhook Secret

When you create a webhook endpoint, you'll receive a signing secret in the format:

whsec_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Store this secret securely - it's only shown once and is required to verify webhook signatures.

Webhook Headers

Each webhook request includes the following headers:

Payload Format

All webhook payloads follow this structure:

{
  "id": "evt_550e8400-e29b-41d4-a716-446655440000",
  "type": "transfer.completed",
  "data": {
    // Event-specific data
  },
  "createdAt": "2026-01-18T10:30:05.000Z"
}

Payload Fields