TIC
Sign in to Lens

WatchList

Send a test event to a webhook notification

Sends a sample event to a webhook notification and returns the payload that was sent.

Pro+ tier
POSThttps://lens-api.tic.io/watchlists/{id}/notifications/{notificationId}/test

The sample goes through the same delivery as real events and is built from the watchlist’s first member when it has one. It carries watchListMemberSubType test and no teamWatchListMemberEventId, so your endpoint can tell it from a real event.

The payload format is described in Webhooks & notifications.

Authorization

x-api-keystringheaderrequired

Your API key, sent in the x-api-key header.

Path parameters

idstringrequired

Watchlist GUID

format: uuid

notificationIdstringrequired

Notification trigger GUID

format: uuid

Responses

The payload queued for delivery · application/json

teamWatchListMemberEventIdinteger

format: int32

teamWatchListMemberIdinteger

format: int32

teamWatchListIdinteger

format: int32

externalIdstring | null
companyIdinteger | null

format: int32

personIdinteger | null

format: int32

addressIdinteger | null

format: int32

apartmentIdinteger | null

format: int32

propertyIdinteger | null

format: int32

vehicleIdinteger | null

format: int32

watchListMemberEventTypestring

One of: 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

watchListMemberSubTypestring | null
eventDatestring

format: date-time

lastUpdatedAtUtcstring

format: date-time