Skip to main content
POST
Configure webhook for organization

Overview

Create and configure a webhook for an organization to receive real-time notifications for asset status updates and threat detections. Requires an API key with access to the specified organization.
See the Webhooks integration guide for the payload shapes and delivery behavior.

Authorizations

X-API-KEY
string
header
required

Your API key. This is required by most endpoints to access our API programatically. Reach out to us at support@chainpatrol.io to get an API key for your use.

Body

application/json
organizationSlug
string
required

Organization slug to configure webhooks for

subscriberUrl
string<uri>
required

HTTPS URL where webhook events will be delivered

triggers
enum<string>[]
required

Array of webhook events to subscribe to

Minimum array length: 1
Available options:
DEBUG_TEST,
ASSET_STATUS_UPDATED,
ORGANIZATION_THREAT_DETECTION_ADDED,
ASSET_STATUS_ESCALATED
description
string

Optional description for the webhook

active
boolean
default:true

Whether the webhook should be active

Response

Successful response

id
number
required

The ID of the created webhook

subscriberUrl
string
required

The webhook URL

description
string | null
required

Webhook description

active
boolean
required

Whether the webhook is active

secret
string
required

Webhook signing secret for verifying payloads

triggers
enum<string>[]
required

Array of subscribed webhook events

Available options:
DEBUG_TEST,
ASSET_STATUS_UPDATED,
ORGANIZATION_THREAT_DETECTION_ADDED,
ASSET_STATUS_ESCALATED
organizationSlug
string
required

Organization slug this webhook belongs to