Abrir en Magpie

Un webhook envía cada respuesta nueva de tus formularios a otra aplicación, como Zapier, Make, n8n o tu propio servidor, en cuanto llega. Los administradores del equipo añaden y cambian los webhooks del equipo.

Añadir un webhook

  1. En Formularios, elige Webhooks.
  2. Elige Añadir webhook.
  3. Ponle un nombre y pega la dirección que te da la otra aplicación, por ejemplo una dirección Catch Hook de Zapier.
  4. Elige Añadir webhook.

Se abre la página del webhook con su secreto de firma. Copia el secreto en ese momento: no se volverá a mostrar.

Un webhook nuevo envía las respuestas de todos los formularios del equipo. Para enviar solo las respuestas de un formulario, elige ese formulario en Formularios, en la página del webhook.

Un equipo puede tener hasta 20 webhooks. Los Ajustes del formulario muestran cuántos de ellos envían sus respuestas, con un enlace a Webhooks.

Cuándo se envía una respuesta

  • Una respuesta a un formulario sin pago se enviará en cuanto se guarde.
  • Una respuesta a un formulario con pago se enviará cuando esté pagada. Una respuesta que nunca se paga no se envía.
  • Cada respuesta se enviará una sola vez a cada webhook.

Qué contiene cada solicitud

Cada solicitud es un POST con un cuerpo JSON. Su type es form.response.created, y su data contiene:

  • team: el identificador y el nombre del equipo.
  • form: el uuid, el título, la dirección y la versión del formulario.
  • response: su uuid, cuándo se envió (submitted_at, en UTC), su dirección en Magpie, sus answers y su payment.

answers lista todas las preguntas del formulario, en orden, cada una con su id, su label, su type y su value. Una pregunta sin responder tiene value null. Una respuesta de casillas es la lista de opciones marcadas.

Un archivo no se envía en sí. Su value tiene el nombre del archivo y una url que lo descarga con una clave de API. Envía la clave, y X-Magpie-Team-Id con el identificador del equipo (consulta Claves de API y API REST).

payment es null en un formulario sin pago. Si no, tiene el estado, el importe en la unidad más pequeña de la moneda, la moneda y cuándo se pagó.

Comprobar que una solicitud viene de Magpie

Cada solicitud lleva las cabeceras X-Magpie-Event, X-Magpie-Id, X-Magpie-Timestamp y X-Magpie-Signature.

  1. Une la marca de tiempo, un punto y el cuerpo sin procesar.
  2. Calcula su HMAC-SHA256 con el secreto de firma.
  3. Compáralo con el valor v1 de X-Magpie-Signature (t=<timestamp>,v1=<signature>).

X-Magpie-Id es el mismo cuando una respuesta se vuelve a enviar. Guárdalo e ignora una solicitud cuyo identificador ya tengas.

Envíos que fallan

Responde con cualquier estado 2xx. Cualquier otra respuesta, o ninguna, se volverá a intentar al cabo de 1, 5 y 30 minutos, y después de 2, 6, 12 y 24 horas. Tras 8 intentos, el envío falla.

La página del webhook lista sus 50 últimos envíos. Enviar de nuevo vuelve a enviar uno fallido, con el mismo identificador.

Desactivar un webhook, cambiar su dirección o su formulario, o eliminarlo cancela las respuestas que aún no ha recibido.

Cambiar o eliminar un webhook

En la página del webhook:

  • Haz clic en su nombre o en su Dirección para cambiarlo.
  • Desactiva Activado para dejar de enviar sin eliminar el webhook.
  • Elige Más y después Nuevo secreto de firma para sustituir el secreto. El anterior deja de funcionar, así que actualiza la aplicación que recibe el webhook.
  • Elige Más y después Eliminar webhook.

Los webhooks en la API

Un programa puede añadir, cambiar y eliminar webhooks con una clave de API, en /api/v1/forms/webhooks. La referencia completa está enlazada desde /docs/api.

Si la firma de un webhook no coincide, o una respuesta no se envía, Contactar con soporte.

Preguntar al soporte de Magpie

Envía al equipo de Magpie una pregunta sobre cualquier cosa que este artículo no responda.