Knowledge base
html-edit-error-mode<signals>DirectiveRefuse delivery or send as is when HTML parsing failed; the default is to refuse.custom-message-id-header<signals>DirectiveThe name of the header with your message identifier; the service uses it to link opens and clicks with the other events.engagement-tracking<signals>DirectiveThree values: do not collect, send the events yourself or let the engine insert links and pixels; the default is not to collect.tracking-domain<signals>DirectiveThe domain that inserted links and pixels point to; the default is the vendor’s domain.enable-bottom-open-pixel<signals>DirectiveThe switch for one of three kinds of insertion; works only with tracking done by the engine, on by default.enable-click-tracking<signals>DirectiveThe switch for one of three kinds of insertion; works only with tracking done by the engine, on by default.enable-top-open-pixel<signals>DirectiveThe switch for one of three kinds of insertion; works only with tracking done by the engine, on by default.use-https<signals>DirectiveMakes inserted links encrypted; requires your own tracking domain with a certificate; off by default.The node can insert pixels and rewrite links by itselfMechanismIn the vendor’s tracking mode the engine parses outgoing HTML, rewrites links to the tracking domain and inserts open pixels — with a choice of what to do if the markup cannot be parsed.Markup parsing and editingMechanismOpen and click tracking in sparkpost mode edits the message markup with the built-in gumbo-parser; by default a message whose markup could not be parsed is bounced.Hand a message to a webhook instead of a receiverMechanismThe queue sends the message as a POST request in the form of a JSON object; only a 2xx response counts as success.