Skip to main content

Custom Endpoint

The Custom Endpoint contact type lets you define an HTTP(s) endpoint URL that we'll POST to, in the place of sending an email or message.

While similar to Webhooks, the Custom Endpoint contact type is different than a Webhook in a few key ways:

  1. Custom Endpoints only receive high-level summary details related to checks, while Webhooks will receive full details.
  2. Custom Endpoints are subject to Scheduling Settings on the Contact, while Webhooks are not.
  3. Custom Endpoints are subject to Contact Group settings, including time-of-day settings, while Webhooks are not.

Payload​

The format of the body of the message delivered to your endpoint URL uses JSON. For example:

{
    "event_sid": "PK4e343bdbfaf0b0a4106bf39975943a69e6fe4c063fe64948372f36180c5d2f75",
    "event_type": "contact.trigger",
    "title": "RBL Listing Event",
    "message": "1 hosts listed, 0 hosts delisted. See link for more details.",
    "url": "https:\/\/rbltrack.com\/fFMa1S"
}

Code Example​

Below is a simple PHP example that shows how to ingest the RAW POST JSON data:

endpoint.php
<?php

$json = file_get_contents('php://input');
if ($json !== false)
{
    $data = json_decode($json);
    print_r($data);
}

This would return:

output
Array
(
    [event_sid] => PK4e343bdbfaf0b0a4106bf39975943a69e6fe4c063fe64948372f36180c5d2f75
    [event_type] => contact.trigger
    [title] => RBL Listing Event
    [message] => 1 hosts listed, 0 hosts delisted. See link for more details.
    [url] => https://rbltrack.com/fFMa1S
)

Adding a Contact​

You can add a Custom Endpoint contact from the Manage ➡️ Contacts section of the Portal.

Select Custom Endpoint from the Contact Type drop-down, enter your webhook URL in the Endpoint URL field, select a Frequency, and select one or more Contact Groups to associate with this new contact.

After clicking Add Contact, you'll receive a confirmation message with a confirmation link that you'll need to click on to confirm your contact.

If you don't receive the confirmation message for some reason, you can also click the Resend Auth option to resend the confirmation message. Once a contact is confirmed, it will be ready to use.