Ospree docs
API ReferenceWebsiteSocials
  • GETTING STARTED
    • Intro to Ospree
      • What is the Travel Rule?
      • Types of Travel Rule transfers
      • What is a wallet address?
      • What is an Account at Ospree?
      • What is a VASP or CASP?
    • Account
      • Understand user roles
      • Add and manage users
      • Change your password
      • Set up two-factor authentication (2FA)
      • Log in with 2FA-enabled
  • DASHBOARD
    • Overview
    • Travel Rule
      • Start a transfer
      • Search and filter transfers
      • Interoperability
      • Self-hosted wallets
    • Accounts Directory
      • Create an account
      • Edit an account
      • Create a recipient
      • Edit a recipient
      • Add a new wallet
      • VASPs
        • Search and filter
        • Request a VASP
  • OSPREE API
    • Overview
    • API integration flows
    • Authentication
    • Breaking Changes
    • Errors
    • Token Identifier
    • Webhooks
      • Webhook events
      • Webhook request
      • Webhook management
    • Travel Rule
      • Create Transfer
      • List Transfers
      • Retrieve Transfer
      • Update Transfer
      • Action Transfer
    • Accounts Directory
      • Create Account
      • List Accounts
      • Retrieve Account
      • Update Account
      • Remove account
      • Search account
      • Retrieve VASP
      • Search VASP
      • List VASPs
    • Blockchain Analytics
      • Create Address
      • List Addresses
      • Retrieve Address
      • Assign an address to account
      • Create Transaction (Beta)
      • List Transactions (Beta)
      • Retrieve Transaction (Beta)
  • Resources and Help
    • Data pre-validation
    • Sunrise Issue
Powered by GitBook
On this page
  1. OSPREE API

Webhooks

Last updated 19 days ago

Webhooks allow Ospree to send real-time HTTPS notifications to your server whenever specific events occur within the platform. Instead of continuously polling for updates, your system receives automated event-based callbacks, ensuring timely and efficient data synchronization. This is particularly useful for tracking compliance-related activities, transaction monitoring, and risk alerts triggered outside your system.

For example, you can receive notifications when a new incoming transfer request is received or when the status of a transfer changes. Key sections include (triggered actions), (payload structure), and (configuration and handling).

  • POST /api/v2/webhooks

  • GET /api/v2/webhooks

  • GET /api/v2/webhooks/event_types

  • DELETE /api/v2/webhooks/:webhook_id

Webhook Events
Webhook Requests
Webhook Management
Webhook Sample Flow
Create Webhook
List Webhooks
List Webhook Event Types
Delete Webhook