Skip to main content
POST
/
webhooks
Create a new webhook
curl --request POST \
  --url https://service.bluumfinance.com/v1/webhooks \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "eventTypeNames": [
    "<string>"
  ],
  "name": "<string>",
  "url": "<string>",
  "description": "<string>"
}
'
{
  "status": "success",
  "message": "Webhook created successfully",
  "data": {
    "webhook": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Order Filled Webhook",
      "url": "https://example.com/webhooks/orders",
      "status": "ACTIVE",
      "eventTypes": [],
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  }
}

Authorizations

Authorization
string
header
required

HTTP Basic Authentication using the API Key as username and API Secret as password.

Body

application/json
eventTypeNames
string[]
required
name
string
required
url
string<uri>
required
description
string | null

Response

Webhook created successfully

status
string
message
string
data
object