Obter todos os webhooks
O endpoint “Get all webhooks” da API foi projetado para fornecer aos usuários a capacidade de recuperar uma lista completa de todos os webhooks que configuraram.
Isso é especialmente útil para gerenciar e auditar webhooks, permitindo que os usuários vejam a quais eventos estão inscritos.
AUTORIZAÇÕES:
Darwin API Key
Chave de API: Darwin API Key
A chave de API é usada para autenticar a solicitação.
Nome do parâmetro no cabeçalho: X-API-KEY
Respostas
200 Corpo da resposta
Requisição
GET /v1/webhook
Exemplo de resposta
Tipo de conteúdo: application/json
[ { "webhookUrl": "https://example.com/webhook", "types": [ ... ] }, { "webhookUrl": "https://example.com/webhook2", "types": [ ... ] } ]Atualizar um webhook existente
A operação “Update an existing webhook” na API do Darwin permite que os usuários modifiquem as configurações ou os parâmetros de um webhook que já foi previamente configurado.
AUTORIZAÇÕES:
Darwin API Key
PARÂMETROS DE CAMINHO
id (string, obrigatório) – ID do webhook a ser atualizado.
ESQUEMA DO CORPO DA REQUISIÇÃO:
application/json
Corpo da requisição
webhookUrl (string, obrigatório) – A URL do webhook para onde os eventos serão enviados.
types (array de strings, obrigatório) –
Valores possíveis:
"session.opened","session.closed","session.forwarded","session.analyzed","session.*","function.call.<functionName>","function.call.*","function.*"Os tipos de eventos que serão enviados ao webhook. É possível usar curingas (
*) para corresponder a vários eventos.
Respostas
204 Corpo da resposta
400 Corpo da resposta
Requisição
PUT /v1/webhook/{id}
Exemplo de requisição
Tipo de conteúdo: application/json
{ "webhookUrl": "https://example.com/webhook", "types": [ "session.opened", "session.closed", "session.forwarded", "session.analyzed", "session.*", "function.call.*" ] }Exemplo de resposta
204 Sucesso:
{}Remover um webhook existente
Remover um webhook existente refere-se ao processo de excluir um webhook previamente configurado, permitindo que os usuários eliminen webhooks desnecessários ou desatualizados e mantenham uma integração mais simples e eficiente.
AUTORIZAÇÕES:
Darwin API Key
Chave de API: Darwin API Key
A chave de API é usada para autenticar a solicitação.
Nome do parâmetro no cabeçalho: X-API-KEY
PARÂMETROS DE CAMINHO
id (string, obrigatório) – ID do webhook a ser removido.
Respostas
204 Corpo da resposta
400 Corpo da resposta
Requisição
DELETE /v1/webhook/{id}
Exemplo de resposta
Tipo de conteúdo: application/json
{}