×

Login to Safe Shepherd

Recover your password

Safe Shepherd API Documentation

WebHooks

The Safe Shepherd API will alert you when new information comes up (or is taken down) on the Internet for any of your users.

Setting up WebHooks

Once you've set your desired endpoint for WebHooks from Safe Shepherd, we'll begin actively sending you noticiations when new events occur for your users.

We will send an event if any (or multiple) of the following occur:

  • A new alert comes up in a user's account
  • A new removable record is discovered for a user
  • A record has been verified as removed from the Internet for a user
  • A new web link is discovered

The WebHook POST body will contain the associated user_id (see User struct) and a JSON-encoded object which contains the relevant alerts, records and/or links included in this notification. To reduce load on your servers, Safe Shepherd webhook notifications group notifications within a 10-minute window into a single API call.

Steps to success

You'll need to set a callback URL to start receiving WebHooks.

Set My WebHooks
POST http://example.com/abc

{
  "user_id": 123,
  "events": [
    "discovered_links",
    "removed_records",
    "new_alerts"
  ],
  "discovered_links": [
    {
      "url": "http://github.com/hayesgm",
      "title": "Github | Hayesgm"
    }
  ],
  "removed_records": [
    {
      "record": {
        "id": 412,
        "name": "Winston Churchill",
        "site": "Zaba Search",
        "status": "removed",
        "age": 55,
        "href": "http://churchilldowns.com",
        "relations": [
          "Mindy Churchill"
        ],
        "aliases": [
          "The Boss"
        ],
        "locations": [
          "Buffalo, NY"
        ],
        "reference_id": "34abtdfjl3-2"
      }
    }
  ],
  "new_alerts": [
    {
      "text": "Safe Shepherd API has submitted an Automated opt-out to Intelius to remove a record which we've identified as having your information.",
      "html": "Safe Shepherd API has submitted an Automated opt-out to\nIntelius\nto remove a record which we've identified as having\nTommy Lee Jones.\n\n",
      "guide": "Intelius is one of the largest people search sites in the industry. It exposes your home addresses, phone numbers, age, date of birth, relatives, income, aliases, and court records, past and present.",
      "opt_out_procedure": [
        "Visit Intelius' [Opt Out page](https://www.intelius.com/optout.php).",
        "Attach a state-issued ID to verify your identity (in our opinion, an unnecessary burden intended to discourage you).",
        "Provide your email address.",
        "In the Additional Information section, indicate that you would also like to be removed from all other databases they own, including Zabasearch.",
        "Click submit.",
        "Your records should be removed in 7-14 days."
      ],
      "source_type": "record",
      "source": {
        "record": {
          "id": 318,
          "name": "Tommy Lee Jones",
          "site": "Intelius",
          "status": "discovered",
          "age": null,
          "href": "http://www.intelius.com/Find-Phone-Address/Clinton-KY/Tommy-Jones.html",
          "relations": [
            "Maria Jones",
            "Jesse Jones"
          ],
          "aliases": [
            "Thom"
          ],
          "locations": [
            "Glendale, CA",
            "Pasadena, CA",
            "North Hollywood, CA"
          ],
          "reference_id": "000560228488"
        }
      }
    }
  ]
}

Unless we get a success, we'll delay 60 seconds and try again. If that fails, we'll try again in 5 minutes and then 30 minutes after that.