Skip to main content
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
}'

Authorizations

​
ds-api-token
string
header
required

Body

application/json

Common Webhook Request

​
is_sandbox
boolean
default:false

For what environment new Webhook should be created

​
webhook_url
string<url>

Your server endpoint where Dataspike service will send AML and Document Verification events

Example:

"https://dataspike.io"

​
event_types
enum<string>[]
Example:
["AML_SCREENING"]
​
enabled
boolean
default:true

Set to false if you want temporarily deactivate webhook

Response

200

Webhook Created