Create Webhook
curl --request POST \
--url https://api.dataspike.io/api/v3/organization/webhooks \
--header 'Content-Type: application/json' \
--header 'ds-api-token: <api-key>' \
--data '
{
"is_sandbox": false,
"webhook_url": "https://dataspike.io",
"event_types": [
"AML_SCREENING"
],
"enabled": true
}
'import requests
url = "https://api.dataspike.io/api/v3/organization/webhooks"
payload = {
"is_sandbox": False,
"webhook_url": "https://dataspike.io",
"event_types": ["AML_SCREENING"],
"enabled": True
}
headers = {
"ds-api-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'ds-api-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
is_sandbox: false,
webhook_url: 'https://dataspike.io',
event_types: ['AML_SCREENING'],
enabled: true
})
};
fetch('https://api.dataspike.io/api/v3/organization/webhooks', 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://api.dataspike.io/api/v3/organization/webhooks",
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([
'is_sandbox' => false,
'webhook_url' => 'https://dataspike.io',
'event_types' => [
'AML_SCREENING'
],
'enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"ds-api-token: <api-key>"
],
]);
$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://api.dataspike.io/api/v3/organization/webhooks"
payload := strings.NewReader("{\n \"is_sandbox\": false,\n \"webhook_url\": \"https://dataspike.io\",\n \"event_types\": [\n \"AML_SCREENING\"\n ],\n \"enabled\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("ds-api-token", "<api-key>")
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://api.dataspike.io/api/v3/organization/webhooks")
.header("ds-api-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"is_sandbox\": false,\n \"webhook_url\": \"https://dataspike.io\",\n \"event_types\": [\n \"AML_SCREENING\"\n ],\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dataspike.io/api/v3/organization/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["ds-api-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"is_sandbox\": false,\n \"webhook_url\": \"https://dataspike.io\",\n \"event_types\": [\n \"AML_SCREENING\"\n ],\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "01927ed4-c928-7a3c-9a30-7ab7cc169d11",
"hmac_signing_secret": "whsec_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1"
}Webhooks
Create Webhook
Allow to create new webhook with specified parameters
POST
/
api
/
v3
/
organization
/
webhooks
Create Webhook
curl --request POST \
--url https://api.dataspike.io/api/v3/organization/webhooks \
--header 'Content-Type: application/json' \
--header 'ds-api-token: <api-key>' \
--data '
{
"is_sandbox": false,
"webhook_url": "https://dataspike.io",
"event_types": [
"AML_SCREENING"
],
"enabled": true
}
'import requests
url = "https://api.dataspike.io/api/v3/organization/webhooks"
payload = {
"is_sandbox": False,
"webhook_url": "https://dataspike.io",
"event_types": ["AML_SCREENING"],
"enabled": True
}
headers = {
"ds-api-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'ds-api-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
is_sandbox: false,
webhook_url: 'https://dataspike.io',
event_types: ['AML_SCREENING'],
enabled: true
})
};
fetch('https://api.dataspike.io/api/v3/organization/webhooks', 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://api.dataspike.io/api/v3/organization/webhooks",
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([
'is_sandbox' => false,
'webhook_url' => 'https://dataspike.io',
'event_types' => [
'AML_SCREENING'
],
'enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"ds-api-token: <api-key>"
],
]);
$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://api.dataspike.io/api/v3/organization/webhooks"
payload := strings.NewReader("{\n \"is_sandbox\": false,\n \"webhook_url\": \"https://dataspike.io\",\n \"event_types\": [\n \"AML_SCREENING\"\n ],\n \"enabled\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("ds-api-token", "<api-key>")
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://api.dataspike.io/api/v3/organization/webhooks")
.header("ds-api-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"is_sandbox\": false,\n \"webhook_url\": \"https://dataspike.io\",\n \"event_types\": [\n \"AML_SCREENING\"\n ],\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dataspike.io/api/v3/organization/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["ds-api-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"is_sandbox\": false,\n \"webhook_url\": \"https://dataspike.io\",\n \"event_types\": [\n \"AML_SCREENING\"\n ],\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "01927ed4-c928-7a3c-9a30-7ab7cc169d11",
"hmac_signing_secret": "whsec_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1"
}Authorizations
Body
application/json
Common Webhook Request
For what environment new Webhook should be created
Your server endpoint where Dataspike service will send AML and Document Verification events
Example:
"https://dataspike.io"
Available options:
AML_SCREENING, DOCVER, TRANSACTION_MONITORING, KYT_WALLET_CHECK Example:
["AML_SCREENING"]
Set to false if you want temporarily deactivate webhook
Response
200 - application/json
Webhook Created
Returned when a webhook is created. hmac_signing_secret is shown only once — store it securely immediately.
Unique ID of the newly created webhook
Example:
"01927ed4-c928-7a3c-9a30-7ab7cc169d11"
HMAC-SHA256 signing secret used to verify the authenticity of incoming webhook requests. Shown only once — store it in a secrets manager or environment variable.
Example:
"whsec_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1"
⌘I