Callback Object Explained

Email Plus offers an extensive and extendable interfacing system with your infrastructure.

📘

Skip click / open instrumentation

eventCallback does not disable link rewriting or the open pixel. Use trackLinks: false and/or trackOpens: false on send. See Track Links & Opens Explained.

Current Connect HTTP callbacks: use Email callback payloads for the live v2 contract — firehose every open/click, engagement results[] always present (latest entry only), and drive handlers from top-level status (use click only when status is CLICKED). This Email Plus page is legacy reference.

Request fields

callback an Object of Objects containing two properties indicating call-backs to be executed when a message changes status or when recipient performs an action on the message (Open/Click).

PathTypeDescription
statusCallbackObjectCallback information regarding message status. Contains two properties called "strategy" and "url".
eventCallbackObjectCallback information regarding events (onClick/onOpen etc.).
If provided, at least one of the event urls must exist.

event callback An object containing two properties — one for onClick and one for onOpen. Routee POSTs to each configured URL for every matching engagement that lands. If supplied, URLs must be valid, reachable, and accept HTTP POST.

PathTypeDescription
onClickString (url)HTTPS URL notified on every click of a tracked link.
Must be a well-formed URL, accepting POST HTTP method
onOpenString (url)HTTPS URL notified on every open of the message.
Must be a well-formed URL, accepting POST HTTP method

Request fields-status callback info

PathTypeDescription
strategyString(Enumeration)Valid values are OnCompletion and OnChange if the object is supplied, this property is required.
urlString (url)The url of the callback.
Must be a well-formed, reachable URL.