Documentation
  • Overview
  • How It Works
  • Developer API
    • Introduction
    • Initial Test
    • Setup
    • JS SDK
    • HTTPS API
      • Identity
      • Identity Status
      • Signal
    • Webhook
    • User Involvement
    • Bans
    • Boilerplates
      • Node.js
    • Types
      • Identity
      • Signal
      • Event
        • Type
        • Level
        • EventSignal
        • Recommendation
          • Ban
            • Action
          • Type
      • ImmediateResult
      • Identifiers
      • Device
      • Location
      • Carrier
      • IP
      • Tor
      • VPN
      • Approvable
Powered by GitBook
On this page
  • Event handling
  • Request body
  • Retry on failure
  1. Developer API

Webhook

Found in Dashboard under Setup > Policies.

Add your HTTPS endpoint as a webhook to receive Events. We recommend using a cloud function, as they are generally reliable and come preconfigured with HTTPS support.

Event handling

Events may contain one or more Recommendations. Design your system to respond accordingly.

Request body

Webhooks will receive a JSON-encoded object in the request body containing a single field.

body object An object containing the following fields:

  • event object An Event.

Retry on failure

Should we fail to send data to your webhook, our system will retry for several minutes using exponential backoff. If we are still unable to send the data, our system will timeout and we will not retry again later.

Please contact Support if you have questions or requirements.

PreviousSignalNextUser Involvement

Last updated 1 year ago