Crear webhook

POSThttps://api.bydomu.com/v1/webhooks

Esta referência é gerada a partir do código da API, por isso as descrições estão em espanhol. Nomes, parâmetros e exemplos são iguais em qualquer idioma.

Suscribe una URL a uno o varios tipos de evento (exactos, objeto.* o *). La respuesta trae el secret con el que se firma cada entrega (X-Domu-Signature): es la ÚNICA vez que se muestra. La URL debe resolver a una dirección pública; se rechazan direcciones privadas o internas.

Permissão

webhooks:write

Chaves

Só secreta (de um servidor)

Cabeçalhos

X-API-Keystringobrigatório

Sua chave secreta.

Idempotency-Keystring

Clave única de la operación (8-128 caracteres de [a-zA-Z0-9._:-]). Un reintento con la misma clave y el mismo cuerpo devuelve la respuesta original sin repetir la operación. Vive 24 horas. · 8–128 chars

Corpo (JSON)

urlstringobrigatório

uri

eventTypesstring[]obrigatório

descriptionstring

≤ 500 chars

Respostas

201Webhook creado, con su secreto

400Datos inválidos: el cuerpo o la query no cumplen el esquema, o `Idempotency-Key` está mal formada.

401UNAUTHORIZED · Clave faltante, inválida, desactivada o vencida.

402PAYMENT_REQUIRED · Cuenta en modo solo lectura: se rechaza toda mutación.

403FORBIDDEN · La clave no puede usar esta operación: falta el scope, es una secreta en el navegador, el nivel de la cuenta no la permite, está suspendida o se alcanzó un tope del plan.

409DUPLICATE · Choca con un dato existente o con el estado actual, o la `Idempotency-Key` ya se usó con otro cuerpo o sigue en curso.

429RATE_LIMITED · Límite de peticiones excedido: el de la clave (`RATE_LIMITED`), el de escrituras de la organización (`TENANT_RATE_LIMITED`) o bloqueo temporal de la IP por claves inválidas.

500INTERNAL_ERROR · Error interno del servidor.

curl -X POST "https://api.bydomu.com/v1/webhooks" \ -H "X-API-Key: $BYDOMU_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "url": "https://hooks.zapier.com/hooks/catch/123456/abcdef/", "eventTypes": [ "deal.won", "contact.*" ], "description": "Zap: negocios ganados a Google Sheets" }'

const res = await fetch("https://api.bydomu.com/v1/webhooks", { method: "POST", headers: { "X-API-Key": process.env.BYDOMU_API_KEY, "Content-Type": "application/json", }, body: JSON.stringify({ "url": "https://hooks.zapier.com/hooks/catch/123456/abcdef/", "eventTypes": [ "deal.won", "contact.*" ], "description": "Zap: negocios ganados a Google Sheets" }), }); const data = await res.json();

import os, requests r = requests.post( "https://api.bydomu.com/v1/webhooks", headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]}, json={ "url": "https://hooks.zapier.com/hooks/catch/123456/abcdef/", "eventTypes": [ "deal.won", "contact.*" ], "description": "Zap: negocios ganados a Google Sheets" } ) data = r.json()