Skip to main content
POST
/
api
/
v2.1
/
webhooks
/
subscriptions
Create webhook subscription
curl --request POST \
  --url https://sandbox.finhub.cloud/api/v2.1/webhooks/subscriptions \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerId": "<string>",
  "subscriptionName": "<string>",
  "description": "<string>",
  "endpointUrl": "<string>",
  "secretKey": "<string>",
  "signatureAlgorithm": "<string>",
  "verifySsl": true,
  "subscribedEvents": [
    "<string>"
  ],
  "maxRetryAttempts": 123,
  "retryBackoffSeconds": 123
}
'
{
  "code": 200,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "message": "Success"
}

Headers

X-Tenant-ID
string
X-User-ID
string

Body

application/json
customerId
string
subscriptionName
string
description
string
endpointUrl
string
secretKey
string
signatureAlgorithm
string
verifySsl
boolean
subscribedEvents
string[]
maxRetryAttempts
integer<int32>
retryBackoffSeconds
integer<int32>

Response

200 - application/json

OK

Standard API response wrapper

code
integer<int32>

HTTP-style status code

Example:

200

data
object

Response payload object

Example:
{
"id": "123e4567-e89b-12d3-a456-426614174000"
}
message
string

Result message

Example:

"Success"