APIs
API Docs
Webhooks
The Detected platform has a series of webhooks that fire when particular events happen within the platform.
Event Name | Description |
|---|---|
Profile.updated | Triggered when the status of the profile has changed, More information on the status changes of a profile can be found here: Profile Status |
Profile.created | Triggered when a new profile is created |
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
A webhook will contain the following information - Webhook Payload
Webhook requests are signed to ensure authenticity. Each request includes a Signature header.
To verify the webhook:
- Generate a signature on your side using the following steps:
- Use the sha256 algorithm.
- Combine the received JSON payload with the secret value provided in the dashboard.
- Compare your generated signature with the Signature header from the webhook request.
If the signatures match, the webhook is verified successfully.