Integrations
Integracoes nativas e vinculos evento -> acao
GET/api/integrations
Conectores disponíveis e o estado de cada conexão do workspace
Escopo exigido: integrations.read
bash
curl "https://api.zapyflow.com.br/api/integrations" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK
DELETE/api/integrations/{installationId}
Desconectar uma integração
Escopo exigido: integrations.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
installationId | path | sim |
bash
curl -X DELETE "https://api.zapyflow.com.br/api/integrations/{installationId}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace
POST/api/integrations/{installationId}/check
Sondar a saúde de uma integração agora
Escopo exigido: integrations.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
installationId | path | sim |
bash
curl -X POST "https://api.zapyflow.com.br/api/integrations/{installationId}/check" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace
GET/api/integrations/{installationId}/targets
Alvos de uma ação (planilhas, agendas, bases, funis)
Escopo exigido: integrations.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
action | query | sim |
targetId | query | não |
installationId | path | sim |
bash
curl "https://api.zapyflow.com.br/api/integrations/{installationId}/targets?action=..." \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace422— Entendido, mas recusado por uma regra
GET/api/integrations/bindings
Vínculos evento → ação do workspace
Escopo exigido: integrations.read
bash
curl "https://api.zapyflow.com.br/api/integrations/bindings" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK
POST/api/integrations/bindings
Criar um vínculo evento → ação
Escopo exigido: integrations.write
Corpo da requisição
| Campo | Tipo | Obrigatório | Restrições |
|---|---|---|---|
installationId | string | sim | min 1, max 40 |
eventName | string | sim | min 1, max 60 |
action | string | sim | min 1, max 60 |
config | object | não | — |
bash
curl -X POST "https://api.zapyflow.com.br/api/integrations/bindings" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respostas
201— Criado404— Não encontrado — também é a resposta quando o recurso é de outro workspace409— Conflito com o estado atual422— Entendido, mas recusado por uma regra
PATCH/api/integrations/bindings/{bindingId}
Atualizar um vínculo
Escopo exigido: integrations.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
bindingId | path | sim |
bash
curl -X PATCH "https://api.zapyflow.com.br/api/integrations/bindings/{bindingId}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace422— Entendido, mas recusado por uma regra
DELETE/api/integrations/bindings/{bindingId}
Apagar um vínculo
Escopo exigido: integrations.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
bindingId | path | sim |
bash
curl -X DELETE "https://api.zapyflow.com.br/api/integrations/bindings/{bindingId}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
204— Sem conteúdo404— Não encontrado — também é a resposta quando o recurso é de outro workspace
GET/api/integrations/sync-jobs
Histórico de sincronizações
Escopo exigido: integrations.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
status | query | não |
bindingId | query | não |
limit | query | não |
cursor | query | não |
bash
curl "https://api.zapyflow.com.br/api/integrations/sync-jobs" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK
POST/api/integrations/sync-jobs/{jobId}/retry
Retentar uma sincronização falha agora
Escopo exigido: integrations.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
jobId | path | sim |
bash
curl -X POST "https://api.zapyflow.com.br/api/integrations/sync-jobs/{jobId}/retry" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
202— Aceito — enfileirado, ainda não concluído404— Não encontrado — também é a resposta quando o recurso é de outro workspace409— Conflito com o estado atual