Website logo
Detected.co
⌘K
APIs
Authentication
Error Handling
Pagination
Versioning
API Docs
Profiles
Analytics
Webhooks
Reference Architectures
CRM Integration example 1
CRM Integration example 2
Legal
End User Privacy Notice
Data Processing Agreement
End User Terms of Use
System Status
Change Log
Docs powered by Archbee
APIs

Webhooks

3min

The Detected platform has a series of webhooks that fire when particular events happen within the platform.

Event Name

Description

Profile Status Change

The status of the profile has changed, More information on the status changes of a profile can be found here: Profile Status

Profile Information Added

A compliance analyst has added additional notes or documents to the profile.

Enabling webhooks

To enable webhooks navigate to the integration information section of the monitoring dashboard. Select status webhooks to open the config section.

  • Webhook URL = the URL that you'd like to recieve the webhook
  • Webhook Secret = a string used to sign the webhook request

Webhook payload

A webhook will contain the full Detected profile - The Profile object

Webhook signing

When a webhook is sent it will contain a header called 'Signature', this header contains a value calculated in the following way:

PHP
$signature = hash_hmac('sha256', $payloadJson, $secret);


You can use the same approach using the secret supplied to verify the authenticity of the webhook request.

Updated 25 Oct 2023
PREVIOUS
Get Analytics
NEXT
Profile Status
Docs powered by Archbee
TABLE OF CONTENTS
Enabling webhooks
Webhook payload
Webhook signing
Docs powered by Archbee