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
}
'
import requests

url = "https://sandbox.finhub.cloud/api/v2.1/webhooks/subscriptions"

payload = {
"customerId": "<string>",
"subscriptionName": "<string>",
"description": "<string>",
"endpointUrl": "<string>",
"secretKey": "<string>",
"signatureAlgorithm": "<string>",
"verifySsl": True,
"subscribedEvents": ["<string>"],
"maxRetryAttempts": 123,
"retryBackoffSeconds": 123
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
customerId: '<string>',
subscriptionName: '<string>',
description: '<string>',
endpointUrl: '<string>',
secretKey: '<string>',
signatureAlgorithm: '<string>',
verifySsl: true,
subscribedEvents: ['<string>'],
maxRetryAttempts: 123,
retryBackoffSeconds: 123
})
};

fetch('https://sandbox.finhub.cloud/api/v2.1/webhooks/subscriptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.finhub.cloud/api/v2.1/webhooks/subscriptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'customerId' => '<string>',
'subscriptionName' => '<string>',
'description' => '<string>',
'endpointUrl' => '<string>',
'secretKey' => '<string>',
'signatureAlgorithm' => '<string>',
'verifySsl' => true,
'subscribedEvents' => [
'<string>'
],
'maxRetryAttempts' => 123,
'retryBackoffSeconds' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://sandbox.finhub.cloud/api/v2.1/webhooks/subscriptions"

payload := strings.NewReader("{\n \"customerId\": \"<string>\",\n \"subscriptionName\": \"<string>\",\n \"description\": \"<string>\",\n \"endpointUrl\": \"<string>\",\n \"secretKey\": \"<string>\",\n \"signatureAlgorithm\": \"<string>\",\n \"verifySsl\": true,\n \"subscribedEvents\": [\n \"<string>\"\n ],\n \"maxRetryAttempts\": 123,\n \"retryBackoffSeconds\": 123\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://sandbox.finhub.cloud/api/v2.1/webhooks/subscriptions")
.header("Content-Type", "application/json")
.body("{\n \"customerId\": \"<string>\",\n \"subscriptionName\": \"<string>\",\n \"description\": \"<string>\",\n \"endpointUrl\": \"<string>\",\n \"secretKey\": \"<string>\",\n \"signatureAlgorithm\": \"<string>\",\n \"verifySsl\": true,\n \"subscribedEvents\": [\n \"<string>\"\n ],\n \"maxRetryAttempts\": 123,\n \"retryBackoffSeconds\": 123\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.finhub.cloud/api/v2.1/webhooks/subscriptions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"customerId\": \"<string>\",\n \"subscriptionName\": \"<string>\",\n \"description\": \"<string>\",\n \"endpointUrl\": \"<string>\",\n \"secretKey\": \"<string>\",\n \"signatureAlgorithm\": \"<string>\",\n \"verifySsl\": true,\n \"subscribedEvents\": [\n \"<string>\"\n ],\n \"maxRetryAttempts\": 123,\n \"retryBackoffSeconds\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "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"