API Reference

Report Surfaced

wbhk
report_surfaced

This webhook is fired when a report is surfaced in our system. The new report may have any number of URLs associated with it, and may contain audit logs for events prior to surfacing.

Payload

Information about the Report Surfaced event, including the report ID, the list of surfaced URLs, the report's Doppel URL, and its display ID. Subscribing endpoints will receive a JSON object with the following fields.

Top-level webhook payload, containing the event type and the event-specific payload.

string
enum
required

The type of event that occurred.

Allowed:
payload
object
required

Payload type for the "Report Surfaced" webhook.

Responses
201

Webhook notification received successfully, and acted upon synchronously.

202

Webhook notification received successfully, but will be acted upon asynchronously.

400

Invalid payload received.

Updated 2 months ago

Did this page help you?
LoadingLoading…

Updated 2 months ago

Did this page help you?