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:
- Ask Tickiti to create a ticket with structured decision fields.
- Let staff review and modify those fields.
- Receive a structured callback when staff submits their decision.
- 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:
- Go to Settings → Interventions (in the Workflow section)
- Click Add
- Configure:
| Field | Value |
|---|---|
| Name | discount_request (example) |
| Title | Discount request |
| Queue | Inbox (or appropriate queue) |
| Remote enabled | Yes |
| Remote epilog URL | https://your-system/api/interventions/epilog |
| Remote timeout | 10 seconds |
- Add UI fields, for example:
| Type | Name | Label |
|---|---|---|
| text | order_price | Order price (net) {{currency}} |
| checkbox | accept | Accept this discount? |
- Ensure these templates exist:
discount_request.private(required)discount_request.public(optional)discount_request.final(optional)
4. Step 2 — Call Tickiti to Create the Ticket
Your remote system calls:
Headers
Body
Important Rules
interventionmust match the Tickiti intervention name exactly.uidmust uniquely identify this intervention instance in your system.- 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:
What your endpoint must do:
- Validate the Bearer token.
- Locate the domain object using
uid. - Apply the decision (e.g. update order price).
- Return HTTP 200 JSON.
Minimum response:
6. Optional — Mark Completion in Tickiti
If you want Tickiti to:
- mark the intervention as completed
- append audit text
- post a final response in the ticket
Return:
Tickiti will:
- Mark the intervention payload as accepted.
- Append
ticket_auditto the staff response. - Render
{intervention}.finaltemplate (if it exists).
7. Token Setup Summary
You need two tokens:
| Direction | Token used |
|---|---|
| Remote → Tickiti | Tickiti API token (ability: create-ticket) |
| Tickiti → Remote | Remote 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
- Remote calls
create_ticketwithintervention + uid + data. - Tickiti creates ticket + shows structured UI.
- Staff review/edit and submit.
- Tickiti calls your epilog endpoint.
- You apply changes and respond.
- Tickiti optionally marks complete and posts final response.