List Webhooks

curl --request GET \
  --url https://api.dataspike.io/api/v3/organization/webhooks \
  --header 'ds-api-token: <api-key>'

{
  "webhooks": [
    {
      "webhook_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
      "is_sandbox": false,
      "webhook_url": "https://dataspike.io",
      "event_types": [
        "AML_SCREENING"
      ],
      "enabled": true
    }
  ]
}

GET

api

organization

webhooks

List Webhooks

curl --request GET \
  --url https://api.dataspike.io/api/v3/organization/webhooks \
  --header 'ds-api-token: <api-key>'

{
  "webhooks": [
    {
      "webhook_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
      "is_sandbox": false,
      "webhook_url": "https://dataspike.io",
      "event_types": [
        "AML_SCREENING"
      ],
      "enabled": true
    }
  ]
}

Authorizations

ds-api-token

string

header

required

Response

200 - application/json

Webhook Configuration List

Webhook Settings List

webhooks

object[]

Show child attributes

webhooks.webhook_id

string<uuid>

Webhook ID registered within the system

Example:

"01827ed4-c928-7a3c-9a30-7ab7cc169d11"

webhooks.is_sandbox

boolean

default:false

For what environment new Webhook should be created

webhooks.webhook_url

string<url>

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

Example:

"https://dataspike.io"

webhooks.event_types

enum<string>[]

Available options:

AML_SCREENING,

DOCVER,

TRANSACTION_MONITORING

Example:

["AML_SCREENING"]

webhooks.enabled

boolean

default:true

Set to false if you want temporarily deactivate webhook

Example of Possible Webhook Events Create Webhook

⌘I

API documentation

Authorizations

Response