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": "<string>",
  "data": {
    "webhook": {
      "eventTypes": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "category": "<string>",
          "description": "<string>",
          "displayName": "<string>"
        }
      ],
      "name": "<string>",
      "url": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "status": "ACTIVE",
      "secret": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.bluumfinance.com/llms.txt

Use this file to discover all available pages before exploring further.

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

Array of webhook event type names (at least one required)

​
name
string
required

Human-readable name for the webhook

​
url
string<uri>
required

Webhook URL endpoint

​
description
string | null

Optional description for the webhook

Response

Webhook created successfully

​
status
string
Example:

"success"

​
message
string
​
data
object