Vortex
  1. Webhooks
Vortex
  • General overview
  • Vortex Ramp Integration Guide
  • Vortex SDK
  • Sandbox Environment
  • Quotes
    • Get existing quote
      GET
    • Create a new quote
      POST
    • Create a quote for the best network
      POST
  • Vortex Widget
    • Widget parameters
    • Generate a widget URL (with quote refresh)
      POST
    • Generating widget URL (for existing quote)
      POST
  • Ramp
    • Get ramp status
      GET
    • Register new ramp process
      POST
    • Update ramp process
      POST
    • Start ramp process
      POST
  • Account Management
    • Brazil
      • Brazilian KYC Process Overview
      • Get user's remaining transaction limits
      • Get user information
      • Get status of the last ramp event for a user
      • Create user or retry KYC
      • Get user's KYC status
      • Start KYC level 2 process for a user
    • Europe
      • Coming soon...
  • Webhooks
    • Overview
    • Register Webhook
      POST
    • Delete Webhook
      DELETE
  • Public Key
    • Overview
    • Public Key
      GET
  • Supported Payment Methods
    GET
  • Supported Cryptocurrencies
    GET
  • Supported Countries
    GET
  • Supported Fiat Currencies
    GET
  1. Webhooks

Register Webhook

Production
https://api.vortexfinance.co
Production
https://api.vortexfinance.co
POST
/v1/webhook
Register a new webhook to receive event notifications.

Request

Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.vortexfinance.co/v1/webhook' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "string",
    "quoteId": "string",
    "sessionId": "string",
    "events": [
        "string"
    ]
}'
Response Response Example
{
    "createdAt": "2025-10-01T16:21:04.648Z",
    "events": [
        "TRANSACTION_CREATED",
        "STATUS_CHANGE"
    ],
    "id": "340ba946-f3f3-4007-893c-3374bfcd096b",
    "isActive": true,
    "sessionId": null,
    "quoteId": "3258910e-93ee-443e-b793-28cc1d4ccdf3",
    "url": "https://your-website.com"
}
Modified at 2025-10-17 10:56:33
Previous
Overview
Next
Delete Webhook
Built with