Developers
Webhooks de saida, entregas e logs
GET/api/developers/deliveries
Entregas de webhook do time
Escopo exigido: developers.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
cursor | query | não |
limit | query | não |
endpointId | query | não |
status | query | não |
event | query | não |
bash
curl "https://api.zapyflow.com.br/api/developers/deliveries" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK403— Proibido, ou a chave não tem este escopo
GET/api/developers/deliveries/{id}
Uma entrega e todas as suas tentativas
Escopo exigido: developers.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl "https://api.zapyflow.com.br/api/developers/deliveries/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace
POST/api/developers/deliveries/{id}/retry
Reenviar uma entrega agora
Escopo exigido: developers.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl -X POST "https://api.zapyflow.com.br/api/developers/deliveries/{id}/retry" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace409— Conflito com o estado atual
GET/api/developers/events
Catálogo de eventos que a plataforma dispara
Escopo exigido: developers.read
bash
curl "https://api.zapyflow.com.br/api/developers/events" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK
GET/api/developers/logs
Listar event logs do time
Escopo exigido: developers.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
page | query | não |
limit | query | não |
event | query | não |
source | query | não |
dateFrom | query | não |
dateTo | query | não |
webhookId | query | não |
bash
curl "https://api.zapyflow.com.br/api/developers/logs" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK403— Proibido, ou a chave não tem este escopo
GET/api/developers/logs/{id}
Detalhes de um event log
Escopo exigido: developers.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl "https://api.zapyflow.com.br/api/developers/logs/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK403— Proibido, ou a chave não tem este escopo404— Não encontrado — também é a resposta quando o recurso é de outro workspace
GET/api/developers/stats
Estatisticas da area de desenvolvedores
Escopo exigido: developers.read
bash
curl "https://api.zapyflow.com.br/api/developers/stats" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK403— Proibido, ou a chave não tem este escopo
GET/api/developers/webhooks
Listar webhook endpoints do time
Escopo exigido: developers.read
bash
curl "https://api.zapyflow.com.br/api/developers/webhooks" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK403— Proibido, ou a chave não tem este escopo
POST/api/developers/webhooks
Criar webhook endpoint
Escopo exigido: developers.write
Corpo da requisição
| Campo | Tipo | Obrigatório | Restrições |
|---|---|---|---|
url | string | sim | — |
events | "message.received" | "message.sent" | "message.status" | "conversation.created" | "conversation.status.changed" | "conversation.resolved" | "conversation.escalated" | "lead.captured" | "order.created" | "order.updated" | "order.deleted" | "appointment.created" | "appointment.updated" | "appointment.deleted" | "crm.card.created" | "crm.card.moved" | "crm.card.updated" | "crm.card.deleted" | "bot.created" | "bot.deleted" | "channel.connected" | "catalog.synced" | "quota.warning" | "quota.exceeded" | "trial.started" | "trial.locked" | "payment.succeeded" | "payment.failed"[] | sim | ≥ 1 items |
description | string | não | max 255 |
bash
curl -X POST "https://api.zapyflow.com.br/api/developers/webhooks" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respostas
201— Criado403— Proibido, ou a chave não tem este escopo
PATCH/api/developers/webhooks/{id}
Atualizar webhook endpoint
Escopo exigido: developers.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
Corpo da requisição
| Campo | Tipo | Obrigatório | Restrições |
|---|---|---|---|
url | string | não | — |
events | "message.received" | "message.sent" | "message.status" | "conversation.created" | "conversation.status.changed" | "conversation.resolved" | "conversation.escalated" | "lead.captured" | "order.created" | "order.updated" | "order.deleted" | "appointment.created" | "appointment.updated" | "appointment.deleted" | "crm.card.created" | "crm.card.moved" | "crm.card.updated" | "crm.card.deleted" | "bot.created" | "bot.deleted" | "channel.connected" | "catalog.synced" | "quota.warning" | "quota.exceeded" | "trial.started" | "trial.locked" | "payment.succeeded" | "payment.failed"[] | não | — |
description | string | não | max 255 |
active | boolean | não | — |
bash
curl -X PATCH "https://api.zapyflow.com.br/api/developers/webhooks/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace
DELETE/api/developers/webhooks/{id}
Deletar webhook endpoint
Escopo exigido: developers.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl -X DELETE "https://api.zapyflow.com.br/api/developers/webhooks/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace
POST/api/developers/webhooks/{id}/test
Enviar evento de teste para webhook
Escopo exigido: developers.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl -X POST "https://api.zapyflow.com.br/api/developers/webhooks/{id}/test" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace