Developers
Webhooks salientes, entregas y registros
GET/api/developers/deliveries
Entregas de webhook del equipo
Ámbito requerido: developers.read
| Parámetro | Dónde | Obligatorio |
|---|---|---|
cursor | query | no |
limit | query | no |
endpointId | query | no |
status | query | no |
event | query | no |
bash
curl "https://api.zapyflow.com.br/api/developers/deliveries" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK403— Prohibido, o la clave no tiene este ámbito
GET/api/developers/deliveries/{id}
Una entrega y todos sus intentos
Ámbito requerido: developers.read
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
bash
curl "https://api.zapyflow.com.br/api/developers/deliveries/{id}" \
-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/developers/deliveries/{id}/retry
Reenviar una entrega ahora
Ámbito requerido: developers.write
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
bash
curl -X POST "https://api.zapyflow.com.br/api/developers/deliveries/{id}/retry" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK404— No encontrado — también es la respuesta cuando el recurso es de otro workspace409— Conflicto con el estado actual
GET/api/developers/events
Catálogo de los eventos que la plataforma emite
Ámbito requerido: developers.read
bash
curl "https://api.zapyflow.com.br/api/developers/events" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK
GET/api/developers/logs
Listar los registros de eventos del equipo
Ámbito requerido: developers.read
| Parámetro | Dónde | Obligatorio |
|---|---|---|
page | query | no |
limit | query | no |
event | query | no |
source | query | no |
dateFrom | query | no |
dateTo | query | no |
webhookId | query | no |
bash
curl "https://api.zapyflow.com.br/api/developers/logs" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK403— Prohibido, o la clave no tiene este ámbito
GET/api/developers/logs/{id}
Detalles de un registro de evento
Ámbito requerido: developers.read
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
bash
curl "https://api.zapyflow.com.br/api/developers/logs/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK403— Prohibido, o la clave no tiene este ámbito404— No encontrado — también es la respuesta cuando el recurso es de otro workspace
GET/api/developers/stats
Estadísticas del área de desarrolladores
Ámbito requerido: developers.read
bash
curl "https://api.zapyflow.com.br/api/developers/stats" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK403— Prohibido, o la clave no tiene este ámbito
GET/api/developers/webhooks
Listar los endpoints de webhook del equipo
Ámbito requerido: developers.read
bash
curl "https://api.zapyflow.com.br/api/developers/webhooks" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK403— Prohibido, o la clave no tiene este ámbito
POST/api/developers/webhooks
Crear un endpoint de webhook
Ámbito requerido: developers.write
Cuerpo de la petición
| Campo | Tipo | Obligatorio | Restricciones |
|---|---|---|---|
url | string | sí | — |
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"[] | sí | ≥ 1 items |
description | string | no | 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 '{ ... }'Respuestas
201— Creado403— Prohibido, o la clave no tiene este ámbito
PATCH/api/developers/webhooks/{id}
Actualizar un endpoint de webhook
Ámbito requerido: developers.write
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
Cuerpo de la petición
| Campo | Tipo | Obligatorio | Restricciones |
|---|---|---|---|
url | string | no | — |
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"[] | no | — |
description | string | no | max 255 |
active | boolean | no | — |
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 '{ ... }'Respuestas
200— OK404— No encontrado — también es la respuesta cuando el recurso es de otro workspace
DELETE/api/developers/webhooks/{id}
Eliminar un endpoint de webhook
Ámbito requerido: developers.write
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
bash
curl -X DELETE "https://api.zapyflow.com.br/api/developers/webhooks/{id}" \
-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/developers/webhooks/{id}/test
Enviar un evento de prueba a un webhook
Ámbito requerido: developers.write
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
bash
curl -X POST "https://api.zapyflow.com.br/api/developers/webhooks/{id}/test" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK404— No encontrado — también es la respuesta cuando el recurso es de otro workspace