Email integration
One approach that has been taken by an introducer is to interrogate emails that are sent by our system. This approach is also called Email Automation. It allows the introducer to update their system with key actions that have taken place (e.g. appointment booked, case completed).
When emails are received they can be interrogated. Originally the introducer who used this approach parsed the subject line and content to determine what the change was.
To improve on this approach, we have added headers to some emails to allow those to be read to understand what has happened to an instruction. Thus, if you implement email automation it does not rely on the content of the email.
NOT RECOMMENDED
This approach is not recommended.
When we send an email we do not know that it will be received. We have put in place a commercial email service to improve our service. But there are many reasons that an email may be rejected. Emails can also be delayed and thus be processed out of order or processed an unacceptable period of time after the action has taken place. Thus this could be a fragile solution.
Headers
There are two headers that are added to emails:
X-InstructionRef- the reference of the InstructionRefX-TMP-InstructionAction- details of the action taken
An example of these headers could be:
X-InstructionRef: TMP103814
X-TMP-InstructionAction: AppointmentBooked:2025-03-05 00:00:00Z:
X-InstructionRef header
This header is added to every email from TMP associated with an Instruction, including those to Introducers, Suppliers or Customers.
X-TMP-InstructionAction header
This header is added for specific actions. A typical header looks like
X-TMP-InstructionAction: AppointmentBooked:2025-03-05 00:00:00Z:
It consists of two parts separated by a : and ended by a :.
- The action taken, e.g. AppointmentBooked
- Any data associated with the action. In the example above the date of the appointment.
INFO
Only the AppointmentBooked action has data. This is the date of the appointment.
The following values can be used for the action taken and only apply to emails sent to introducers
- Referred, e.g.
Referred:: - Ordered, e.g.
Ordered:: - AppointmentBooked, e.g.
AppointmentBooked:2025-03-05 00:00:00Z: - AppointmentCancelled, e.g.
AppointmentCancelled:: - CaseCompleted, e.g.
CaseCompleted:: - CaseCancelled, e.g.
CaseCancelled:: - PutCaseOnHold, e.g.
PutCaseOnHold:: - TakeCaseOffHold, e.g.
TakeCaseOffHold::
INFO
This approach only applies for Introducers.
If you wish to use this as an Introducer the headers will already be present.
If you wish to use this approach as a Supplier please contact us and we can add the relevant headers.