Tickiti Interventions – Quick Start Guide

This article and the rest of the API documentation in this section are written for a technical audience — integrators and developers connecting external systems to Tickiti. Familiarity with HTTP, REST, JSON and bearer-token authentication is assumed.

This is the fast path for integrators who want to connect a remote system to Tickiti and implement a working intervention in the shortest possible time. For the full conceptual explanation see Tickiti intervention integrator’s guide; for field-by-field reference see Interventions reference.

1. What You’re Building

An intervention allows your system to:

  1. Ask Tickiti to create a ticket with structured decision fields.
  2. Let staff review and modify those fields.
  3. Receive a structured callback when staff submits their decision.
  4. Optionally confirm completion and add a final ticket response.

Think of it as:

“Remote system asks Tickiti for a human decision, and gets the structured result back.”

2. Minimum Integration Steps

You need to implement two things:

✅ A. Remote → Tickiti: Create intervention ticket

✅ B. Tickiti → Remote: Epilog endpoint to receive the decision

That’s it.

3. Step 1 — Create an Intervention in Tickiti

In Tickiti:

  1. Go to Settings → Interventions (in the Workflow section)
  2. Click Add
  3. Configure:
FieldValue
Namediscount_request (example)
TitleDiscount request
QueueInbox (or appropriate queue)
Remote enabledYes
Remote epilog URLhttps://your-system/api/interventions/epilog
Remote timeout10 seconds
  1. Add UI fields, for example:
TypeNameLabel
textorder_priceOrder price (net) {{currency}}
checkboxacceptAccept this discount?
  1. Ensure these templates exist:
  2. discount_request.private (required)
  3. discount_request.public (optional)
  4. discount_request.final (optional)

4. Step 2 — Call Tickiti to Create the Ticket

Your remote system calls:

POST /api/create_ticket

Headers

Authorization: Bearer <tickiti_api_token>
Idempotency-Key: <uuid>
Content-Type: application/json

Body

{
"originator_email_address": "customer@example.com",
"intervention": "discount_request",
"uid": "order-12345-discount",
"data": {
"data": {
"currency": "GBP",
"order_price": 100,
"accept": false
}
}
}

Important Rules

  1. intervention must match the Tickiti intervention name exactly.
  2. uid must uniquely identify this intervention instance in your system.
  3. Always send an Idempotency-Key.

If successful, Tickiti creates a ticket and shows the intervention UI to staff.

5. Step 3 — Implement the Epilog Endpoint

Tickiti will call your configured remote_epilog_url when staff submit the intervention.

Example incoming request:

{
"ticket_id": 12345,
"response_id": 67890,
"uid": "order-12345-discount",
"intervention": "discount_request",
"action": "submit",
"data": {
"currency": "GBP",
"order_price": 95,
"accept": true
}
}

What your endpoint must do:

  1. Validate the Bearer token.
  2. Locate the domain object using uid.
  3. Apply the decision (e.g. update order price).
  4. Return HTTP 200 JSON.

Minimum response:

{ "ok": true }

6. Optional — Mark Completion in Tickiti

If you want Tickiti to:

  1. mark the intervention as completed
  2. append audit text
  3. post a final response in the ticket

Return:

{
"ok": true,
"ticket_id": 12345,
"uid": "order-12345-discount",
"intervention": "discount_request",
"final": {
"response_id": 67890,
"ticket_audit": "Discount applied at 95 GBP. Order updated.",
"remote_reference": "ORD-10021"
}
}

Tickiti will:

  1. Mark the intervention payload as accepted.
  2. Append ticket_audit to the staff response.
  3. Render {intervention}.final template (if it exists).

7. Token Setup Summary

You need two tokens:

DirectionToken used
Remote → TickitiTickiti API token (ability: create-ticket)
Tickiti → RemoteRemote bearer token stored in Intervention settings

Tokens are generated in the Intervention settings screen.

8. What Makes a Good Intervention Design?

✔ Use a stable, unique uid

✔ Keep the data bag minimal

✔ Make templates clear and human-readable

✔ Put domain logic in the remote system

✔ Use final.ticket_audit for meaningful audit text

9. End-to-End Flow Summary

  1. Remote calls create_ticket with intervention + uid + data.
  2. Tickiti creates ticket + shows structured UI.
  3. Staff review/edit and submit.
  4. Tickiti calls your epilog endpoint.
  5. You apply changes and respond.
  6. Tickiti optionally marks complete and posts final response.