APIs

Webhooks

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 following information - Webhook Payload

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


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