Saltar al contenido principal
POST
Configure webhook for organization

Descripción general

Crea y configura un webhook (Webhooks: notificaciones automáticas que la plataforma envía a otro sistema) para que una organización reciba notificaciones en tiempo real sobre las actualizaciones de estado de los assets (Asset: activo digital, como una URL, dirección, perfil, app, etc.) y sobre nuevas Suspected Threats (amenazas sospechosas detectadas automáticamente, todavía sin confirmar). Requiere una clave de API con acceso a la organización especificada.
Consulta la guía de integración de Webhooks para conocer la estructura de los payloads y el comportamiento de las entregas.

Autorizaciones

X-API-KEY
string
header
requerido

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.

Cuerpo

application/json
organizationSlug
string
requerido

Organization slug to configure webhooks for

subscriberUrl
string<uri>
requerido

HTTPS URL where webhook events will be delivered

triggers
enum<string>[]
requerido

Array of webhook events to subscribe to

Minimum array length: 1
Opciones disponibles:
DEBUG_TEST,
ASSET_STATUS_UPDATED,
ORGANIZATION_THREAT_DETECTION_ADDED,
ASSET_STATUS_ESCALATED,
ASSET_ESCALATION_RESOLVED,
AUDIT_LOG_CREATED
description
string

Optional description for the webhook

active
boolean
predeterminado:true

Whether the webhook should be active

Respuesta

Successful response

id
number
requerido

The ID of the created webhook

subscriberUrl
string
requerido

The webhook URL

description
string | null
requerido

Webhook description

active
boolean
requerido

Whether the webhook is active

secret
string
requerido

Webhook signing secret for verifying payloads

triggers
enum<string>[]
requerido

Array of subscribed webhook events

Opciones disponibles:
DEBUG_TEST,
ASSET_STATUS_UPDATED,
ORGANIZATION_THREAT_DETECTION_ADDED,
ASSET_STATUS_ESCALATED,
ASSET_ESCALATION_RESOLVED,
AUDIT_LOG_CREATED
organizationSlug
string
requerido

Organization slug this webhook belongs to