Obtener todos los webhooks
El endpoint “Get all webhooks” de la API está diseñado para proporcionar a los usuarios la capacidad de recuperar una lista completa de todos los webhooks que han configurado.
Esto es especialmente útil para gestionar y auditar webhooks, permitiendo a los usuarios ver a qué eventos están suscritos.
AUTORIZACIONES:
Darwin API Key
Clave API: Darwin API Key
La clave API se utiliza para autenticar la solicitud.
Nombre del parámetro en el encabezado: X-API-KEY
Respuestas
200 Cuerpo de la respuesta
Solicitud
GET /v1/webhook
Ejemplo de respuesta
Tipo de contenido: application/json
[ { "webhookUrl": "https://example.com/webhook", "types": [ ... ] }, { "webhookUrl": "https://example.com/webhook2", "types": [ ... ] } ]Actualizar un webhook existente
La operación “Update an existing webhook” en la API de Darwin permite a los usuarios modificar la configuración o los parámetros de un webhook que ya hayan configurado previamente.
AUTORIZACIONES:
Darwin API Key
PARÁMETROS DE RUTA
id (string, requerido) – ID del webhook que se desea actualizar.
ESQUEMA DEL CUERPO DE LA SOLICITUD:
application/json
Cuerpo de la solicitud
webhookUrl (string, requerido) – La URL del webhook al que se enviarán los eventos.
types (array de strings, requerido) –
Valores permitidos:
"session.opened","session.closed","session.forwarded","session.analyzed","session.*","function.call.<functionName>","function.call.*","function.*"Los tipos de eventos que se enviarán al webhook. Puedes usar comodines (
*) para coincidir con múltiples eventos.
Respuestas
204 Cuerpo de la respuesta
400 Cuerpo de la respuesta
Solicitud
PUT /v1/webhook/{id}
Ejemplo de solicitud
Tipo de contenido: application/json
{ "webhookUrl": "https://example.com/webhook", "types": [ "session.opened", "session.closed", "session.forwarded", "session.analyzed", "session.*", "function.call.*" ] }Ejemplo de respuesta
204 Éxito:
{}Eliminar un webhook existente
Eliminar un webhook existente se refiere al proceso de borrar un webhook previamente configurado, permitiendo a los usuarios limpiar los webhooks innecesarios o desactualizados y mantener una integración más ordenada y eficiente.
AUTORIZACIONES:
Darwin API Key
Clave API: Darwin API Key
La clave API se utiliza para autenticar la solicitud.
Nombre del parámetro en el encabezado: X-API-KEY
PARÁMETROS DE RUTA
id (string, requerido) – ID del webhook que se desea eliminar.
Respuestas
204 Cuerpo de la respuesta
400 Cuerpo de la respuesta
Solicitud
DELETE /v1/webhook/{id}
Ejemplo de respuesta
Tipo de contenido: application/json
{}