Svix

Footprint Webhook Event Types

This is the list of event types that we currently send. For guidance on how to listen to these events, take a look at Svix's guide to consuming webhooks.

footprint.onboarding.status_changed

The status of an onboarding has changed

Example OnboardingStatusChangedPayload
JSON
{
  "fp_id": "fp_id_xyz",
  "new_status": "pass",
  "requires_manual_review": false,
  "timestamp": "2024-03-29T03:56:40.282490123Z"
}

footprint.onboarding.completed

An onboarding was just completed

Example OnboardingCompletedPayload
JSON
{
  "fp_id": "fp_id_xyz",
  "requires_manual_review": false,
  "status": "pass",
  "timestamp": "2024-03-29T03:56:39.687155049Z"
}

footprint.watchlist_check.completed

A watchlist check has run for the vault

Example WatchlistCheckCompletedPayload
JSON
{
  "error": null,
  "fp_id": "fp_id_xyz",
  "status": "pending",
  "timestamp": "2024-03-29T03:56:40.467519430Z"
}