Webhooks

Hooks

suscribir · dar de baja · muestra

El recurso hooks es la mitad de la API que gestiona las suscripciones. Cómo se entregan los eventos —y por qué como mucho una vez— está en Webhooks.

Suscribir#

curl -X POST "$ORKASA_API/hooks" \
  -H "Authorization: Bearer $ORKASA_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "event_type": "deal_won",
    "target_url": "https://hooks.zapier.com/hooks/catch/123/abc/"
  }'

Responde 201 con { "id": "…" } plano, sin envoltorio data: Zapier guarda el cuerpo entero como su subscribeData.

El permiso necesario es el :read del recurso del evento — solo te podemos avisar de lo que ya podías leer.

Dar de baja#

curl -X DELETE "$ORKASA_API/hooks/<id>" -H "Authorization: Bearer $ORKASA_KEY"

204, siempre. Repetirla, o darse de baja de algo que ya no existe, no es un error: así un Zap que se desmonta nunca falla en ese paso. El borrado queda acotado a la agencia de la credencial, tenga los permisos que tenga.

Muestra#

curl "$ORKASA_API/hooks/sample?event_type=deal_won" \
  -H "Authorization: Bearer $ORKASA_KEY"

Filas recientes que ya están en el estado terminal del evento, en el envoltorio normal data. Un REST-hook no tiene pasado que enseñar mientras construyes el Zap; esto llena el paso de « probar el disparador », y sirve además como alternativa por consulta.