Integrations
Native integrations and event → action bindings
GET/api/integrations
Available connectors and the state of each workspace connection
Required scope: integrations.read
bash
curl "https://api.zapyflow.com.br/api/integrations" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Responses
200— OK
DELETE/api/integrations/{installationId}
Disconnect an integration
Required scope: integrations.write
| Parameter | In | Required |
|---|---|---|
installationId | path | yes |
bash
curl -X DELETE "https://api.zapyflow.com.br/api/integrations/{installationId}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Responses
200— OK404— Not found — also returned when the resource belongs to another workspace
POST/api/integrations/{installationId}/check
Probe an integration's health now
Required scope: integrations.write
| Parameter | In | Required |
|---|---|---|
installationId | path | yes |
bash
curl -X POST "https://api.zapyflow.com.br/api/integrations/{installationId}/check" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Responses
200— OK404— Not found — also returned when the resource belongs to another workspace
GET/api/integrations/{installationId}/targets
Targets for an action (spreadsheets, calendars, bases, pipelines)
Required scope: integrations.read
| Parameter | In | Required |
|---|---|---|
action | query | yes |
targetId | query | no |
installationId | path | yes |
bash
curl "https://api.zapyflow.com.br/api/integrations/{installationId}/targets?action=..." \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Responses
200— OK404— Not found — also returned when the resource belongs to another workspace422— Understood, but rejected by a rule
GET/api/integrations/bindings
The workspace's event → action bindings
Required scope: integrations.read
bash
curl "https://api.zapyflow.com.br/api/integrations/bindings" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Responses
200— OK
POST/api/integrations/bindings
Create an event → action binding
Required scope: integrations.write
Request body
| Field | Type | Required | Constraints |
|---|---|---|---|
installationId | string | yes | min 1, max 40 |
eventName | string | yes | min 1, max 60 |
action | string | yes | min 1, max 60 |
config | object | no | — |
bash
curl -X POST "https://api.zapyflow.com.br/api/integrations/bindings" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Responses
201— Created404— Not found — also returned when the resource belongs to another workspace409— Conflict with the current state422— Understood, but rejected by a rule
PATCH/api/integrations/bindings/{bindingId}
Update a binding
Required scope: integrations.write
| Parameter | In | Required |
|---|---|---|
bindingId | path | yes |
bash
curl -X PATCH "https://api.zapyflow.com.br/api/integrations/bindings/{bindingId}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Responses
200— OK404— Not found — also returned when the resource belongs to another workspace422— Understood, but rejected by a rule
DELETE/api/integrations/bindings/{bindingId}
Delete a binding
Required scope: integrations.write
| Parameter | In | Required |
|---|---|---|
bindingId | path | yes |
bash
curl -X DELETE "https://api.zapyflow.com.br/api/integrations/bindings/{bindingId}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Responses
204— No content404— Not found — also returned when the resource belongs to another workspace
GET/api/integrations/sync-jobs
Sync history
Required scope: integrations.read
| Parameter | In | Required |
|---|---|---|
status | query | no |
bindingId | query | no |
limit | query | no |
cursor | query | no |
bash
curl "https://api.zapyflow.com.br/api/integrations/sync-jobs" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Responses
200— OK
POST/api/integrations/sync-jobs/{jobId}/retry
Retry a failed sync now
Required scope: integrations.write
| Parameter | In | Required |
|---|---|---|
jobId | path | yes |
bash
curl -X POST "https://api.zapyflow.com.br/api/integrations/sync-jobs/{jobId}/retry" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Responses
202— Accepted — queued, not finished404— Not found — also returned when the resource belongs to another workspace409— Conflict with the current state