Email integration overview

This section is for SiteLock partners who want to manage email communications with their customers for branding or workflow purposes. It covers retrieving in-dashboard messagess from the SiteLock queue, displaying them to users, and notifying SiteLock that a message has been processed by marking it as sent via the API.

SiteLock communicates with users to keep them informed of the following:

  • The status of scans or workflows

  • Suggested or required actions for the user to take

  • Next steps in a workflow

The API endpoint is:

https://api.sitelock.com/v1/partner
Your partner account must be configured for email white-labeling before this API returns results. The functionality can be configured so that during your development phase SiteLock populates the email queue and sends email on your behalf to the user.

There are two approaches to leveraging email integration.

  1. getPendingEmails

    • Provides the ID of the message to be sent to the user

    • Provides other message metadata in addition to the ID

    • Provides a set of dynamic elements that represent placeholder/value pairs. This set is based on the default email template used by SiteLock only.

    • Provides completely translated and substituted text that SiteLock would have sent to the user if email were not white-labeled. This text isn’t customizable. It’s the SiteLock default, it may change at any time, and is provided for informational purposes only.

  2. getPendingEmailsSimple used in conjunction with getMessageTypes.

    • getPendingEmailsSimple

      • Provides the ID of the message to be sent to the user, but provides no other message type metadata.

      • Provides a set of dynamic elements that represent placeholder/value pairs. This set is based on the email template used by SiteLock for the message in question.

      • The formatting of this set of placeholder/value pair elements differs from the getPendingEmails output.

    • getMessageTypes

      • Provides metadata for in-dashboard messages, which can be linked back using getPendingEmailsSimple

Either request can be used to retrieve pending messages. Once a message is processed, call markEmailsSent to prevent SiteLock from resending it.