← Back to TradeDispatch

Developers & Zapier

Connect TradeDispatch to the tools you already use: Jobber, Housecall Pro, Google Sheets, your CRM and thousands more through Zapier. Integrations can read your calls, leads, bookings and customers and add customers or bookings. They can never text or email your customers, change consent, or change your settings.

Authentication

The business owner creates a key in the dashboard under Integrations. Keys are shown once and only reach that one business. Send it on every request:

Base URL:  https://tradedispatch.us/api/public/v1
Header:    Authorization: Bearer td_live_…   (or X-API-Key: td_live_…)

Test the connection:

GET /me
→ 200 { "business_id": "…", "business_name": "3rd Gospel Heating & Cooling", "api_version": "2026-11-01" }

Limits: 60 requests per minute and 5,000 per day per key (429 with Retry-After). Errors look like { "error": { "code": "…", "message": "…" } }.

Triggers (webhooks)

Subscribe a URL to an event. Each delivery is a POST with a JSON envelope, sent at least once and retried after 1 minute, 5 minutes, 30 minutes, 2 hours, 6 hours and 24 hours. Use id to ignore duplicates. A hook stops after 20 failures in a row, after 3 days of failing, or right away if your endpoint answers 410.

Targets must use HTTPS on hooks.zapier.com, without credentials, fragments or nonstandard ports. Each key can have 50 active subscriptions. The owner receives an email when a connection is added and can remove it in Integrations. Unsubscribe must use the same API key that created the subscription.

POST /hooks        { "event": "booking.created", "target_url": "https://hooks.zapier.com/…" }
→ 201 { "id": "<hook id>", "event": "booking.created", "signing_secret": "<hex>" }

DELETE /hooks/<hook id>   → 200 { "id": "…", "deleted": true }

GET /events/<event>?limit=25   → newest items first (sample data / polling), same envelope as deliveries

Signature header: X-TradeDispatch-Signature: t=<unix seconds>,v1=<hex> where v1 = HMAC-SHA256(signing_secret, "<t>.<raw body>"). Also sent: X-TradeDispatch-Event and X-TradeDispatch-Event-Id.

Local times and readable job types

These fields are additive: existing fields and api_version: 2026-11-01 are unchanged, so existing Zaps keep working. Every event's data, and the booking or customer object in create responses, includes time_zone with the business's IANA time zone, such as America/Chicago. A missing or invalid business time zone defaults to America/Chicago.

New call call.created

A call to your line has finished and been summarized (test calls excluded).

{
  "id": "8f1c2b9e-…",
  "event": "call.created",
  "api_version": "2026-11-01",
  "occurred_at": "2026-11-12T15:03:10Z",
  "occurred_at_local": "2026-11-12T09:03:10-06:00",
  "business_id": "e9a1…",
  "data": {
    "call_id": "…",
    "started_at": "2026-11-12T15:00:00Z",
    "ended_at": "2026-11-12T15:03:10Z",
    "duration_seconds": 190,
    "caller_name": "Pat Example",
    "caller_phone": "+19205550100",
    "call_type": "service",
    "outcome": "callback",
    "urgency": "routine",
    "emergency": false,
    "service_address": "12 Elm St, Appleton, WI",
    "summary": "Furnace not heating; wants a visit this week.",
    "time_zone": "America/Chicago",
    "started_at_local": "2026-11-12T09:00:00-06:00",
    "ended_at_local": "2026-11-12T09:03:10-06:00"
  }
}

New lead (callback needed) lead.created

A service call that didn't book, or a booking/service request from the customer app.

{
  "id": "8f1c2b9e-…",
  "event": "lead.created",
  "api_version": "2026-11-01",
  "occurred_at": "2026-11-12T15:04:05Z",
  "occurred_at_local": "2026-11-12T09:04:05-06:00",
  "business_id": "e9a1…",
  "data": {
    "lead_id": "…",
    "source": "call",
    "created_at": "2026-11-12T15:04:05Z",
    "name": "Pat Example",
    "phone": "+19205550100",
    "email": null,
    "address": "12 Elm St",
    "service": "Furnace not heating",
    "urgency": "routine",
    "requested_start": null,
    "callback_needed": true,
    "time_zone": "America/Chicago",
    "created_at_local": "2026-11-12T09:04:05-06:00"
  }
}

New booking booking.created

A job is scheduled (by the phone assistant, the owner or an integration).

{
  "id": "8f1c2b9e-…",
  "event": "booking.created",
  "api_version": "2026-11-01",
  "occurred_at": "2026-11-12T15:04:05Z",
  "occurred_at_local": "2026-11-12T09:04:05-06:00",
  "business_id": "e9a1…",
  "data": {
    "booking_id": "…",
    "customer_id": "…",
    "status": "booked",
    "scheduled_start": "2026-11-16T21:00:00Z",
    "scheduled_end": "2026-11-16T22:00:00Z",
    "job_type": "quote",
    "title": "Replacement estimate",
    "customer_name": "Pat Example",
    "customer_phone": "+19205550100",
    "address": "12 Elm St",
    "source": "call",
    "confirmation": "confirmed",
    "created_at": "2026-11-12T15:04:05Z",
    "updated_at": "2026-11-12T15:04:05Z",
    "time_zone": "America/Chicago",
    "scheduled_start_local": "2026-11-16T15:00:00-06:00",
    "scheduled_end_local": "2026-11-16T16:00:00-06:00",
    "created_at_local": "2026-11-12T09:04:05-06:00",
    "scheduled_date_local": "2026-11-16",
    "scheduled_time_local": "3:00 PM",
    "job_type_label": "Quote / replacement estimate"
  }
}

Booking changed booking.updated

A booked job's time, address, job type or customer changes.

{
  "id": "8f1c2b9e-…",
  "event": "booking.updated",
  "api_version": "2026-11-01",
  "occurred_at": "2026-11-13T15:00:00Z",
  "occurred_at_local": "2026-11-13T09:00:00-06:00",
  "business_id": "e9a1…",
  "data": {
    "booking_id": "…",
    "customer_id": "…",
    "status": "booked",
    "scheduled_start": "2026-11-16T21:00:00Z",
    "scheduled_end": "2026-11-16T22:00:00Z",
    "job_type": "quote",
    "title": "Replacement estimate",
    "customer_name": "Pat Example",
    "customer_phone": "+19205550100",
    "address": "12 Elm St",
    "source": "call",
    "confirmation": "confirmed",
    "created_at": "2026-11-12T15:04:05Z",
    "updated_at": "2026-11-13T15:00:00Z",
    "time_zone": "America/Chicago",
    "scheduled_start_local": "2026-11-16T15:00:00-06:00",
    "scheduled_end_local": "2026-11-16T16:00:00-06:00",
    "created_at_local": "2026-11-12T09:04:05-06:00",
    "scheduled_date_local": "2026-11-16",
    "scheduled_time_local": "3:00 PM",
    "job_type_label": "Quote / replacement estimate"
  }
}

Booking cancelled booking.cancelled

A booked job is cancelled.

{
  "id": "8f1c2b9e-…",
  "event": "booking.cancelled",
  "api_version": "2026-11-01",
  "occurred_at": "2026-11-13T16:00:00Z",
  "occurred_at_local": "2026-11-13T10:00:00-06:00",
  "business_id": "e9a1…",
  "data": {
    "booking_id": "…",
    "customer_id": "…",
    "status": "cancelled",
    "scheduled_start": "2026-11-16T21:00:00Z",
    "scheduled_end": "2026-11-16T22:00:00Z",
    "job_type": "quote",
    "title": "Replacement estimate",
    "customer_name": "Pat Example",
    "customer_phone": "+19205550100",
    "address": "12 Elm St",
    "source": "call",
    "confirmation": "confirmed",
    "created_at": "2026-11-12T15:04:05Z",
    "updated_at": "2026-11-13T16:00:00Z",
    "time_zone": "America/Chicago",
    "scheduled_start_local": "2026-11-16T15:00:00-06:00",
    "scheduled_end_local": "2026-11-16T16:00:00-06:00",
    "created_at_local": "2026-11-12T09:04:05-06:00",
    "scheduled_date_local": "2026-11-16",
    "scheduled_time_local": "3:00 PM",
    "job_type_label": "Quote / replacement estimate"
  }
}

Job completed job.completed

A visit is recorded as done.

{
  "id": "8f1c2b9e-…",
  "event": "job.completed",
  "api_version": "2026-11-01",
  "occurred_at": "2026-11-16T22:05:00Z",
  "occurred_at_local": "2026-11-16T16:05:00-06:00",
  "business_id": "e9a1…",
  "data": {
    "visit_id": "…",
    "booking_id": "…",
    "customer_id": "…",
    "visit_date": "2026-11-16",
    "completed_at": "2026-11-16T22:05:00Z",
    "title": "Furnace tune-up",
    "tuneup": true,
    "summary": "Customer-visible visit summary",
    "time_zone": "America/Chicago",
    "completed_at_local": "2026-11-16T16:05:00-06:00"
  }
}

New customer customer.created

A customer is added, including customer app sign-ups.

{
  "id": "8f1c2b9e-…",
  "event": "customer.created",
  "api_version": "2026-11-01",
  "occurred_at": "2026-11-12T15:04:05Z",
  "occurred_at_local": "2026-11-12T09:04:05-06:00",
  "business_id": "e9a1…",
  "data": {
    "customer_id": "…",
    "name": "Pat Example",
    "phone": "+19205550100",
    "email": "pat@example.com",
    "address": "12 Elm St",
    "company": null,
    "source": "app",
    "member": false,
    "sms_opted_out": false,
    "created_at": "2026-11-12T15:04:05Z",
    "time_zone": "America/Chicago",
    "created_at_local": "2026-11-12T09:04:05-06:00"
  }
}

New Complete Care sign-up care_signup.created

Someone signs up for the membership plan. Public sign-ups stay unlinked (customer_id null) until the owner links them.

{
  "id": "8f1c2b9e-…",
  "event": "care_signup.created",
  "api_version": "2026-11-01",
  "occurred_at": "2026-11-12T15:04:05Z",
  "occurred_at_local": "2026-11-12T09:04:05-06:00",
  "business_id": "e9a1…",
  "data": {
    "signup_id": "…",
    "created_at": "2026-11-12T15:04:05Z",
    "status": "new",
    "customer_id": null,
    "name": "Pat Example",
    "phone": "+19205550100",
    "email": "pat@example.com",
    "address": "12 Elm St",
    "billing": "monthly",
    "systems": {
      "furnace": 1,
      "ac": 1
    },
    "estimate": "$29.95/month",
    "time_zone": "America/Chicago",
    "created_at_local": "2026-11-12T09:04:05-06:00"
  }
}

Actions and searches

Create customer

If the phone or email already belongs to a customer, that customer is returned with matched: true instead of making a duplicate. Creating a customer never grants texting or email permission.

POST /customers
{ "name": "Pat Example", "phone": "920-555-0100", "email": "pat@example.com", "address": "12 Elm St", "company": null }
→ 201
{
  "matched": false,
  "customer": {
    "customer_id": "…",
    "name": "Pat Example",
    "phone": "+19205550100",
    "email": "pat@example.com",
    "address": "12 Elm St",
    "company": null,
    "source": "manual",
    "member": false,
    "sms_opted_out": false,
    "created_at": "2026-11-12T15:04:05Z",
    "time_zone": "America/Chicago",
    "created_at_local": "2026-11-12T09:04:05-06:00"
  }
}
→ 200 with matched: true and the same customer fields when an existing customer matches

Create booking

Follows the business's working hours, job lengths, travel buffer and daily job limit, and never double-books. Needs online scheduling turned on for the business. No text, email or call goes to the customer or the owner for these bookings. Send external_id to make retries safe.

POST /jobs
{ "customer_id": "…", "job_type": "quote", "date": "2026-11-16", "start_time": "15:00", "address": "12 Elm St", "notes": "From Jobber", "external_id": "jobber-123" }
→ 201
{
  "created": true,
  "booking": {
    "booking_id": "…",
    "customer_id": "…",
    "status": "booked",
    "scheduled_start": "2026-11-16T21:00:00Z",
    "scheduled_end": "2026-11-16T22:00:00Z",
    "job_type": "quote",
    "title": "Quote / replacement estimate",
    "customer_name": "Pat Example",
    "customer_phone": "+19205550100",
    "address": "12 Elm St",
    "source": "integration",
    "confirmation": "confirmed",
    "created_at": "2026-11-12T15:04:05Z",
    "updated_at": "2026-11-12T15:04:05Z",
    "time_zone": "America/Chicago",
    "scheduled_start_local": "2026-11-16T15:00:00-06:00",
    "scheduled_end_local": "2026-11-16T16:00:00-06:00",
    "created_at_local": "2026-11-12T09:04:05-06:00",
    "scheduled_date_local": "2026-11-16",
    "scheduled_time_local": "3:00 PM",
    "job_type_label": "Quote / replacement estimate"
  }
}
→ 200 with created: false and the same booking fields for a repeated external_id
→ 409 { "error": { "code": "conflict" | "outside_hours", "message": "…", "suggested_starts": ["2026-11-16T22:30:00Z", …] } }
→ 422 unknown_job_type (lists valid keys) | scheduling_unavailable | in_past

Find customer

GET /customers/search?phone=9205550100   (or ?email=pat@example.com)
→ 200 [ { …customer… } ]   exact matches only, up to 5

What's never shared

Private owner notes, call recordings and transcripts, photos, payment and accounting details, and anything from another business.