When a Contact signs up, unsubscribes, has a bounce logged against them or performs an interaction with one of your Emails, you can have Sentori pass this information on to an external system, such as your CRM system, to keep everything in sync.

Sentori calls this Webhook when a Contact signs up by clicking the Opt In Confirmation Link after submitting a Sentori Form, or when a User manually adds a single Contact.

To use this feature, set the Contact Subscribe Webhook for your account by signing in to Sentori then going to the Settings menu and choosing API.

Note: This Webhook is not called when uploading Contacts.

This is how Sentori structures its request to your external system when a Contact subscribes:

Note the Source value of “User”, indicating the Contact was created by a User within Sentori.

POST [your webhook url] HTTP/1.1
Content-Type: application/json
User-Agent: Sentori API
Content-Length: 314

{
  "AccountExternalID" : "1234ABCD",
  "EmailAddress" : "user@example.com",
  "Type" : "subscribe",
  "Date" : "2016-10-28T14:59:43.6889402Z",
  "Source" : "User",
  "vhash" : "EC0A73A0091CF860DCBD0B572CD8042A9B702D7B",
  "Description" : "\"user@example.com\" logged \"subscribe\" Event at \"Fri 28 Oct 2016 14:59 UTC\"."
}

To confirm the request isn't from another system impersonating Sentori, perform the following operation.

1. Concatenate the AccountExternalID, EmailAddress, Type, Date, Source values from the request (so exclude Description and vhash) and your API Key
2. Convert the result into bytes
3. Get the SHA1 hash of those bytes and remove any hyphen characters

If the result matches the vhash value in the request, it's genuine.

Here's the example above being checked using C# code:

The API Key of this Sentori Account is “20011111-1111-1111-1111-111111111200”.

string values = "1234ABCD" + "user@example.com" + "subscribe" + "2016-10-28T14:59:43.6889402Z" + "User" + "20011111-1111-1111-1111-111111111200";
byte[] bytes = System.Text.Encoding.Default.GetBytes(values);
System.Security.Cryptography.SHA1Managed sha1 = new System.Security.Cryptography.SHA1Managed();
string checkHash = BitConverter.ToString(sha1.ComputeHash(bytes));
checkHash = checkHash.Replace("-", string.Empty);
// Output is "true" if genuine, "false" if not.
Console.WriteLine("Is genuine? " + ("EC0A73A0091CF860DCBD0B572CD8042A9B702D7B" == checkHash));

Sentori calls this Webhook when a Contact becomes unsubscribed, either by the Unsubscribe link in an Email being clicked or a User manually unsubscribing them in Sentori.

To use this feature, set the Contact Unsubscribe Webhook for your account by signing in to Sentori then going to the Settings menu and choosing API.

Note: This Webhook is not called when uploading a Suppression List.

This is how Sentori structures its request to your external system when a Contact unsubscribes:

POST [your webhook url] HTTP/1.1
Content-Type: application/json
User-Agent: Sentori API
Content-Length: 314

{
    "AccountExternalID":"1234ABCD",
    "EmailAddress":"user@example.com",
    "Type":"unsubscribe",
    "Date":"2016-02-01T14:12:59.1230000Z",
    "vhash":"F88EA6387F4CF9F258521444C34FEB526DF66A55",
    "Description":"\"user@example.com\" logged \"unsubscribe\" Event at \"Mon 01 Feb 2016 14:12 UTC\"."
}

To confirm the request isn't from another system impersonating Sentori, perform the following operation.

1. Concatenate the AccountExternalID, EmailAddress, Type, Date values from the request (so exclude Description and vhash) and your API Key
2. Convert the result into bytes
3. Get the SHA1 hash of those bytes and remove any hyphen characters

If the result matches the vhash value in the request, it's genuine.

Here's the example above being checked using C# code:

The API Key of this Sentori Account is “20011111-1111-1111-1111-111111111200”.

string values = "1234ABCD" + "user@example.com" + "unsubscribe" + "2016-02-01T14:12:59.1230000Z" + "20011111-1111-1111-1111-111111111200";
byte[] bytes = System.Text.Encoding.Default.GetBytes(values);
System.Security.Cryptography.SHA1Managed sha1 = new System.Security.Cryptography.SHA1Managed();

string checkHash = BitConverter.ToString(sha1.ComputeHash(bytes));
checkHash = checkHash.Replace("-", string.Empty);

// Output is "true" if genuine, "false" if not.
Console.WriteLine("Is genuine? " + ("F88EA6387F4CF9F258521444C34FEB526DF66A55" == checkHash));

Sentori calls this Webhook when a Contact is added to a Mailing List, whether by a Contact performing an action or a User through Sentori's interface.

Note: This Webhook is not called when uploading Contacts.

This is how Sentori structures its request to your external system when a Contact is added to a Mailing List:

POST [your webhook url] HTTP/1.1
Content-Type: application/json
User-Agent: Sentori API
Content-Length: 410

{
  "AccountExternalID" : "1234ABCD",
  "EmailAddress" : "user@example.com",
  "MailingListExternalID" : "ABCD1234",
  "Type" : "subscribe",
  "Date" : "2016-10-28T14:59:43.6889402Z",
  "vhash" : "EC0A73A0091CF860DCBD0B572CD8042A9B702D7B",
  "Description" : "\"user@example.com\" logged \"subscribe\" Event for Mailing List \"Members Offers\" (ExternalID: ABCD1234) at \"Fri 28 Oct 2016 14:59 UTC\"."
}

To confirm the request isn't from another system impersonating Sentori, perform the following operation.

1. Concatenate the AccountExternalID, EmailAddress, MailingListExternalID, Type, Date values from the request (so exclude Description and vhash) and your API Key
2. Convert the result into bytes
3. Get the SHA1 hash of those bytes and remove any hyphen characters

If the result matches the vhash value in the request, it's genuine.

Here's the example above being checked using C# code:

The API Key of this Sentori Account is “20011111-1111-1111-1111-111111111200”.

string values = "1234ABCD" + "user@example.com" + "ABCD1234" + "subscribe" + "2016-10-28T14:59:43.6889402Z" + "20011111-1111-1111-1111-111111111200";
byte[] bytes = System.Text.Encoding.Default.GetBytes(values);
System.Security.Cryptography.SHA1Managed sha1 = new System.Security.Cryptography.SHA1Managed();
string checkHash = BitConverter.ToString(sha1.ComputeHash(bytes));
checkHash = checkHash.Replace("-", string.Empty);
// Output is "true" if genuine, "false" if not.
Console.WriteLine("Is genuine? " + ("0321B442144F3EF8663EF47D738E2EDEDEBDF73F" == checkHash));

Sentori calls this Webhook when a Contact is removed from a Mailing List, whether by a Contact performing an action (including Unsubscribing from the Account) or a User through Sentori's interface.

Note: This Webhook is not called when uploading a Suppression List.

This is how Sentori structures its request to your external system when a Contact is removed from a Mailing List:

POST [your webhook url] HTTP/1.1
Content-Type: application/json
User-Agent: Sentori API
Content-Length: 414

{
  "AccountExternalID" : "1234ABCD",
  "EmailAddress" : "user@example.com",
  "MailingListExternalID" : "ABCD1234",
  "Type" : "unsubscribe",
  "Date" : "2016-10-28T14:59:43.6889402Z",
  "vhash" : "EC0A73A0091CF860DCBD0B572CD8042A9B702D7B",
  "Description" : "\"user@example.com\" logged \"unsubscribe\" Event for Mailing List \"Members Offers\" (ExternalID: ABCD1234) at \"Fri 28 Oct 2016 14:59 UTC\"."
}

To confirm the request isn't from another system impersonating Sentori, perform the following operation.

1. Concatenate the AccountExternalID, EmailAddress, MailingListExternalID, Type, Date values from the request (so exclude Description and vhash) and your API Key
2. Convert the result into bytes
3. Get the SHA1 hash of those bytes and remove any hyphen characters

If the result matches the vhash value in the request, it's genuine.

Here's the example above being checked using C# code:

The API Key of this Sentori Account is “20011111-1111-1111-1111-111111111200”.

string values = "1234ABCD" + "user@example.com" + "ABCD1234" + "unsubscribe" + "2016-10-28T14:59:43.6889402Z" + "20011111-1111-1111-1111-111111111200";
byte[] bytes = System.Text.Encoding.Default.GetBytes(values);
System.Security.Cryptography.SHA1Managed sha1 = new System.Security.Cryptography.SHA1Managed();
string checkHash = BitConverter.ToString(sha1.ComputeHash(bytes));
checkHash = checkHash.Replace("-", string.Empty);
// Output is "true" if genuine, "false" if not.
Console.WriteLine("Is genuine? " + ("6769BC487AB5F54FE2AA5858FB6260FBFB0DD7A2" == checkHash));

Sentori calls this Webhook when a bounce occurs as a result of attempting to send an email to a Contact.

To use this feature, set the Email Bounce Webhook for your account by signing in to Sentori then going to the Settings menu and choosing API.

Depending on the information contained in a bounce and whether any previous bounces have occurred, Sentori will either log the bounce and immediately set the Contact to “Bad” (by setting their “Bad Email Address” Field to “Yes”) or just log the bounce which goes towards a Contact's overall bounce count.

Contacts are marked as “Bad” when their “Bad Email Address” boolean Field is set to “True” (or “Yes”). Sentori excludes those Contacts from sends.

This is how Sentori structures its request to your external system when a bounce occurs:

POST [your webhook url] HTTP/1.1
Content-Type: application/json
User-Agent: Sentori API
Content-Length: 455

{
    "AccountExternalID":"1234ABCD",
    "EmailAddress":"user@example.com",
    "ContactMarkedBad":true,
    "BounceType":"Hard",
    "BounceReason":"Email address does not exist",
    "Date":"2016-03-01T15:51:00.1230000Z",
    "vhash":"1485836BE3A0908DC50A42CC22BB76340EF263C0",
    "Description":"Bounce logged for email address \"user@example.com\" at \"Tue 01 Mar 2016 15:51 UTC\".\\n\\nThe Contact HAS been marked as having a Bad Email Address due to the total number of Bounces logged.\\n\\nBounce Details:\\nHard\\nEmail address does not exist"
}

To confirm the request isn't from another system impersonating Sentori, perform the following operation.

1. Concatenate the AccountExternalID, EmailAddress, ContactMarkedBad (converting it to a lowercase string, e.g. “true” or “false”), BounceType, BounceReason, Date values from the request (so exclude vhash and Description) and your API Key
2. Convert the result into bytes
3. Get the SHA1 hash of those bytes and remove any hyphen characters

If the result matches the vhash value in the request, it's genuine.

Here's the example above being checked using C# code:

The API Key of this Sentori Account is “20011111-1111-1111-1111-111111111200”.

string values = "1234ABCD" + "user@example.com" + true.ToString().ToLower() + "Hard" + "Email address does not exist" + "2016-03-01T15:51:00.1230000Z" + "20011111-1111-1111-1111-111111111200";
byte[] bytes = System.Text.Encoding.Default.GetBytes(values);
System.Security.Cryptography.SHA1Managed sha1 = new System.Security.Cryptography.SHA1Managed();

string checkHash = BitConverter.ToString(sha1.ComputeHash(bytes));
checkHash = checkHash.Replace("-", string.Empty);

// Output is "true" if genuine, "false" if not.
Console.WriteLine("Is genuine? " + ("1485836BE3A0908DC50A42CC22BB76340EF263C0" == checkHash));

Sentori calls this Webhook when a Contact first performs certain interactions with an Email (e.g. opens the email or clicks a link) you can have Sentori pass this information on to an external system that may perform additional tasks.

To use this feature, set the Interactions Webhook on an Email by clicking the Email Tools menu button and selecting Interactions Webhook.

You'll be presented with a popup that allows you to enter a URL to the external system, as well tickboxes for each interaction that Sentori currently supports. Initially this is limited to External Link Clicks, but further options will be added in future.

NOTE: Sentori will only call your webhook URL the first time each of your Contacts performs one of your selected interactions, not every time. So (once we've implemented this for Opens) if a Contact Opens your email 5 times, it would only be called for the first Open. Each link is considered a separate interaction so it would be called the first time a Contact clicks each link.

This is how Sentori structures its request to your external system when a selected interaction occurs:

POST [your webhook url] HTTP/1.1
Content-Type: application/json
User-Agent: Sentori API
Content-Length: 376

{
  "AccountExternalID" : "1234ABCD",
  "AccountName" : "My Account",
  "EmailExternalID" : "S8JE72AD",
  "EmailName" : "Newsletter",
  "Type" : "ExternalLinkClick",
  "Value" : "http://website.co.uk/homepage/#info",
  "Name" : "Website Homepage",
  "ContactSystemID" : 5841,
  "ContactEmailAddress" : "user@example.com",
  "Date" : "2016-08-04T09:15:28.1744295Z"
}