Send a test event to a webhook notification
curl --request POST \
--url https://lens-api.tic.io/watchlists/{id}/notifications/{notificationId}/test \
--header 'x-api-key: <api-key>'import requests
url = "https://lens-api.tic.io/watchlists/{id}/notifications/{notificationId}/test"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('https://lens-api.tic.io/watchlists/{id}/notifications/{notificationId}/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://lens-api.tic.io/watchlists/{id}/notifications/{notificationId}/test",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://lens-api.tic.io/watchlists/{id}/notifications/{notificationId}/test"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://lens-api.tic.io/watchlists/{id}/notifications/{notificationId}/test")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://lens-api.tic.io/watchlists/{id}/notifications/{notificationId}/test")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"teamWatchListMemberEventId": 123,
"teamWatchListMemberId": 123,
"teamWatchListId": 123,
"externalId": "<string>",
"companyId": 123,
"personId": 123,
"addressId": 123,
"apartmentId": 123,
"propertyId": 123,
"vehicleId": 123,
"watchListMemberEventType": "companyAddress",
"watchListMemberSubType": "<string>",
"eventDate": "2023-11-07T05:31:56Z",
"lastUpdatedAtUtc": "2023-11-07T05:31:56Z"
}
]Watchlist
Send a test event to a webhook notification
Queues one sample event for the webhook, in the same format and through the same delivery as real events, and returns the payload that is sent. The sample is built from the watchlist’s first member when it has one. The webhook body carries watchListMemberSubType test and no teamWatchListMemberEventId, so your endpoint can tell it from a real event.
POST
/
watchlists
/
{id}
/
notifications
/
{notificationId}
/
test
Send a test event to a webhook notification
curl --request POST \
--url https://lens-api.tic.io/watchlists/{id}/notifications/{notificationId}/test \
--header 'x-api-key: <api-key>'import requests
url = "https://lens-api.tic.io/watchlists/{id}/notifications/{notificationId}/test"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('https://lens-api.tic.io/watchlists/{id}/notifications/{notificationId}/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://lens-api.tic.io/watchlists/{id}/notifications/{notificationId}/test",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://lens-api.tic.io/watchlists/{id}/notifications/{notificationId}/test"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://lens-api.tic.io/watchlists/{id}/notifications/{notificationId}/test")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://lens-api.tic.io/watchlists/{id}/notifications/{notificationId}/test")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"teamWatchListMemberEventId": 123,
"teamWatchListMemberId": 123,
"teamWatchListId": 123,
"externalId": "<string>",
"companyId": 123,
"personId": 123,
"addressId": 123,
"apartmentId": 123,
"propertyId": 123,
"vehicleId": 123,
"watchListMemberEventType": "companyAddress",
"watchListMemberSubType": "<string>",
"eventDate": "2023-11-07T05:31:56Z",
"lastUpdatedAtUtc": "2023-11-07T05:31:56Z"
}
]Pro+ tier
The payload format is described in Webhooks & notifications.
Authorizations
Path Parameters
Watchlist GUID
Notification trigger GUID
Response
The payload queued for delivery
Available options:
companyAddress, companyName, companyStatus, companyRegistration, companyIntelligence, companyBeneficialOwner, companyDocument, companyWorkplace, companyPerson, companyRegisteredOffice, companyShareCapital, companyPurpose, companyDebtBalance, companyOrderToPayCase, companyFinancialDocument, companyCase, companyWorkplaceAddress, unused_Company4, unused_Company5, unused_Company6, unused_Company7, unused_Company8, unused_Company9, unused_Company10, personAddress, personName, personIntelligence, personStatus, personCompany, unused_Person1, unused_Person2, unused_Person3, unused_Person4, unused_Person5, unused_Person6, unused_Person7, unused_Person8, unused_Person9, unused_Person10, propertyOwnershipChange, propertyMortageDeedChange, unused_Property1, unused_Property2, unused_Property3, unused_Property4, unused_Property5, vehicleOwnerChange, vehicleUserChange, vehicleStatusChange, vehicleInspection, vehicleStolen, unused_Vehicle1, unused_Vehicle2, unused_Vehicle3, unused_Vehicle4, unused_Vehicle5, residentMovedIn, residentMovedOut, unused_Resident1, unused_Resident2, unused_Resident3, unused_Resident4, unused_Resident5