Integrations
Integraciones nativas y vínculos evento → acción
GET/api/integrations
Conectores disponibles y el estado de cada conexión del workspace
Ámbito requerido: integrations.read
curl "https://api.zapyflow.com.br/api/integrations" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK
DELETE/api/integrations/{installationId}
Desconectar una integración
Ámbito requerido: integrations.write
| Parámetro | Dónde | Obligatorio |
|---|---|---|
installationId | path | sí |
curl -X DELETE "https://api.zapyflow.com.br/api/integrations/{installationId}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK404— No encontrado — también es la respuesta cuando el recurso es de otro workspace
POST/api/integrations/{installationId}/check
Sondear la salud de una integración ahora
Ámbito requerido: integrations.write
| Parámetro | Dónde | Obligatorio |
|---|---|---|
installationId | path | sí |
curl -X POST "https://api.zapyflow.com.br/api/integrations/{installationId}/check" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK404— No encontrado — también es la respuesta cuando el recurso es de otro workspace
GET/api/integrations/{installationId}/targets
Destinos de una acción (hojas de cálculo, agendas, bases, embudos)
Ámbito requerido: integrations.read
| Parámetro | Dónde | Obligatorio |
|---|---|---|
action | query | sí |
targetId | query | no |
installationId | path | sí |
curl "https://api.zapyflow.com.br/api/integrations/{installationId}/targets?action=..." \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK404— No encontrado — también es la respuesta cuando el recurso es de otro workspace422— Entendido, pero rechazado por una regla
GET/api/integrations/bindings
Vínculos evento → acción del workspace
Ámbito requerido: integrations.read
curl "https://api.zapyflow.com.br/api/integrations/bindings" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK
POST/api/integrations/bindings
Crear un vínculo evento → acción
Ámbito requerido: integrations.write
Cuerpo de la petición
| Campo | Tipo | Obligatorio | Restricciones |
|---|---|---|---|
installationId | string | sí | min 1, max 40 |
eventName | string | sí | min 1, max 60 |
action | string | sí | min 1, max 60 |
config | object | no | — |
curl -X POST "https://api.zapyflow.com.br/api/integrations/bindings" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respuestas
201— Creado404— No encontrado — también es la respuesta cuando el recurso es de otro workspace409— Conflicto con el estado actual422— Entendido, pero rechazado por una regla
PATCH/api/integrations/bindings/{bindingId}
Actualizar un vínculo
Ámbito requerido: integrations.write
| Parámetro | Dónde | Obligatorio |
|---|---|---|
bindingId | path | sí |
curl -X PATCH "https://api.zapyflow.com.br/api/integrations/bindings/{bindingId}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK404— No encontrado — también es la respuesta cuando el recurso es de otro workspace422— Entendido, pero rechazado por una regla
DELETE/api/integrations/bindings/{bindingId}
Eliminar un vínculo
Ámbito requerido: integrations.write
| Parámetro | Dónde | Obligatorio |
|---|---|---|
bindingId | path | sí |
curl -X DELETE "https://api.zapyflow.com.br/api/integrations/bindings/{bindingId}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
204— Sin contenido404— No encontrado — también es la respuesta cuando el recurso es de otro workspace
GET/api/integrations/sync-jobs
Historial de sincronizaciones
Ámbito requerido: integrations.read
| Parámetro | Dónde | Obligatorio |
|---|---|---|
status | query | no |
bindingId | query | no |
limit | query | no |
cursor | query | no |
curl "https://api.zapyflow.com.br/api/integrations/sync-jobs" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK
POST/api/integrations/sync-jobs/{jobId}/retry
Reintentar una sincronización fallida ahora
Ámbito requerido: integrations.write
| Parámetro | Dónde | Obligatorio |
|---|---|---|
jobId | path | sí |
curl -X POST "https://api.zapyflow.com.br/api/integrations/sync-jobs/{jobId}/retry" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
202— Aceptado — en cola, aún no concluido404— No encontrado — también es la respuesta cuando el recurso es de otro workspace409— Conflicto con el estado actual